FridayAI
FridayAI is an interactive gaming assistant that provides real-time information, quest tracking, and game guides for popular games.
Features
- Real-time overlay with game information
- Quest tracking and progress monitoring
- Interactive maps and location guides
- Item database with search functionality
- User account and subscription management
- Multi-platform support (Windows, macOS, Linux)
Development Setup
Prerequisites
- PHP 8.1 or higher
- Composer
- Node.js and npm
- SQLite3
Installation
Clone the repository:
git clone https://github.com/your-username/fridayai.git
cd fridayai
Install PHP dependencies:
composer install
Install JavaScript dependencies:
npm install
Copy the environment configuration:
cp .env.example .env
Edit the .env
file with your configuration settings.
Setup the databases:
cd database
bash ./setup_databases.sh
Build the frontend assets:
npm run build
Start the development server:
php -S localhost:8000 -t public
Production Deployment
Heroku Deployment
We use Heroku for hosting the application with the following setup:
- Automatic deployment from the main branch
- PostgreSQL for the production database
- S3 for storing application assets and files
To deploy to production, use the deployment script:
./deploy.sh
This script will:
- Verify database structures
- Install production dependencies
- Create/configure Heroku app if needed
- Configure environment variables
- Deploy the application
Manual Deployment
If you need to manually deploy:
Create a Heroku app:
heroku create fridayai-prod
Add PostgreSQL:
heroku addons:create heroku-postgresql:hobby-dev
Configure environment variables:
heroku config:set APP_ENV=production
heroku config:set APP_DEBUG=false
heroku config:set S3_BUCKET=fridayai-downloads-2025
heroku config:set S3_REGION=us-east-1
Add all necessary secrets and API keys.
Deploy the application:
git push heroku main
Monitoring
Monitor the application using Heroku logs:
heroku logs --tail
Database
The application uses SQLite for development and PostgreSQL for production.
system.sqlite
: Main application database
- Game-specific databases in
data/game_data/
License
This project is proprietary software. All rights reserved.