Altify - Dark Social Network Documentation

Installation

Prerequisites

✓ Node.js 18+
✓ Python 3.8+
✓ PostgreSQL 12+
✓ Redis 6+

Quick Start

                        git clone https://github.com/yava-code/Altify.git

cd Altify

npm install

npm run dev

The application will start on http://localhost:5173

Key Features

AI-Powered Matching

Advanced algorithms match users based on mood patterns, interests, and emotional compatibility.

Dark Theme

Beautiful, eye-friendly dark interface designed for extended use and reduced eye strain.

Mood Tracking

Track your emotional journey with detailed analytics and insights over time.

Usage Guidelines

User Registration

New users can register with email, username, and password. The system validates input and creates secure user profiles.

// Registration endpoint
POST /api/auth/register
{
  "email": "user@example.com",
  "username": "darkuser",
  "password": "securePassword123"
}

Mood Diary

Users can log their mood with text entries, emotional tags, and intensity levels. Data is stored securely and used for AI matching.

// Create diary entry
POST /api/diary
{
  "content": "Feeling contemplative today...",
  "mood_tags": ["contemplative", "creative"],
  "intensity": 7
}

API Reference

Authentication API

POST /api/auth/register

POST /api/auth/login

Authenticate user and return access token

POST /api/auth/logout

Invalidate user session

Configuration

Environment Variables

# Database
DATABASE_URL=postgresql://user:password@localhost:5432/altify

# Redis
REDIS_URL=redis://localhost:6379

# JWT Secret
JWT_SECRET=your-super-secret-jwt-key

# Supabase
VITE_SUPABASE_URL=https://your-project.supabase.co
VITE_SUPABASE_ANON_KEY=your-anon-key

Troubleshooting

Database Connection Issues

Ensure PostgreSQL is running and the DATABASE_URL is correctly configured. Check firewall settings and database permissions.

Authentication Failures

Verify JWT_SECRET is properly set and Supabase credentials are correct. Check network connectivity to authentication services.

Contribution Guidelines

How to Contribute

Fork the repository
Create a feature branch (git checkout -b feature/amazing-feature)
Commit your changes (git commit -m 'Add amazing feature')
Push to the branch (git push origin feature/amazing-feature)
Open a Pull Request

Please ensure your code follows our style guidelines and includes appropriate tests. Run npm run lint and npm test before submitting.

License

This project is licensed under the MIT License - see the LICENSE file for details.

Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction...

Altify Documentation