🚀 Quick Start Guide

Welcome! This guide will get you up and running in minutes. For more details, please see the Main Documentation.

Installation Video (Local Setup)

Installation Steps

1. Firebase App Hosting (Recommended)

1. Create Project & Upgrade: Create a Firebase project and upgrade it to the Blaze (pay-as-you-go) plan.
2. Push to GitHub: Upload the source-code folder to a new GitHub repository.
3. Connect to App Hosting: In Firebase, create a new App Hosting backend and connect your GitHub repo.
4. Deploy: Add your GEMINI_API_KEY as a secret and deploy.
5. Run Installer: Visit your new site's URL. You will be redirected to /install to finalize setup.

2. Shared Hosting / cPanel

1. Setup Node.js App: In cPanel, create a new Node.js application.
2. Upload Files: Upload the contents of the source-code folder to your app's root directory.
3. Install & Configure: Use the cPanel interface to run npm install and set your GEMINI_API_KEY as an environment variable.
4. Start & Install: Start the app. Visit your domain, and you'll be redirected to /install to complete the setup.

3. VPS (Virtual Private Server)

1. Upload & Install: Upload the source-code folder, then run npm install inside the directory.
2. Environment: Create a .env file (or use system variables) for your GEMINI_API_KEY.
3. Build & Run: Build the app with npm run build. Use a process manager like PM2 to start it: pm2 start npm --name "my-app" -- start.
4. Web Installer: Access your server's IP/domain to be redirected to the /install page and finish setup.

4. Local Computer

1. Unzip & Install: Unzip the source-code folder. Open a terminal inside it and run npm install.
2. Run App: Start the application with npm run dev.
3. Web Installer: Open your browser to http://localhost:3000. You will be redirected to the /install page.
4. Configure: Follow the on-screen steps to enter your Firebase keys and create an admin user.
5. AI Key: Create a .env file and add your GEMINI_API_KEY=....