feat: update README and deployment docs for clarity and Python version requirement
Co-authored-by: Copilot <copilot@github.com>
This commit is contained in:
@@ -1,7 +1,16 @@
|
|||||||
# AI
|
# All You Can GET AI
|
||||||
|
|
||||||
A multi-modal AI web application. Users can choose between different AI models for text generation, text-to-image, text-to-video, and image-to-video generation, powered by [openrouter.ai](https://openrouter.ai).
|
A multi-modal AI web application. Users can choose between different AI models for text generation, text-to-image, text-to-video, and image-to-video generation, powered by [openrouter.ai](https://openrouter.ai).
|
||||||
|
|
||||||
|
Key features:
|
||||||
|
|
||||||
|
- Multi-modal AI generation (text, images, videos)
|
||||||
|
- User authentication and role-based access control
|
||||||
|
- Admin dashboard for managing users, models, and video jobs
|
||||||
|
- Gallery for viewing generated images and videos
|
||||||
|
- Chat interface with message history
|
||||||
|
- Image upload and preview functionality
|
||||||
|
|
||||||
## Components
|
## Components
|
||||||
|
|
||||||
| Component | Technology | Description |
|
| Component | Technology | Description |
|
||||||
@@ -31,33 +40,58 @@ python -m venv .venv
|
|||||||
# Linux/macOS
|
# Linux/macOS
|
||||||
source .venv/bin/activate
|
source .venv/bin/activate
|
||||||
|
|
||||||
# Install dependencies
|
# Install core dependencies
|
||||||
pip install -r requirements.txt
|
pip install -r requirements.txt
|
||||||
|
|
||||||
# Copy and fill in environment variables
|
# Install development dependencies
|
||||||
|
pip install -r backend/requirements-dev.txt
|
||||||
|
pip install -r frontend/requirements-dev.txt
|
||||||
|
|
||||||
|
# Copy environment variables file
|
||||||
cp .env.example .env
|
cp .env.example .env
|
||||||
|
|
||||||
|
# Edit .env file and add your OpenRouter API key and configure other settings
|
||||||
|
nano .env
|
||||||
```
|
```
|
||||||
|
|
||||||
### Running the backend
|
### Running the application locally
|
||||||
|
|
||||||
|
#### Backend (FastAPI + Uvicorn)
|
||||||
|
|
||||||
```bash
|
```bash
|
||||||
cd backend
|
cd backend
|
||||||
uvicorn app.main:app --reload --port 12015
|
uvicorn app.main:app --reload --port 12015
|
||||||
```
|
```
|
||||||
|
|
||||||
### Running the frontend
|
#### Frontend (Flask)
|
||||||
|
|
||||||
```bash
|
```bash
|
||||||
cd frontend
|
cd frontend
|
||||||
flask --app app.main run --port 12016
|
flask --app app.main run --port 12016 --debug
|
||||||
```
|
```
|
||||||
|
|
||||||
### Running tests
|
### Running tests
|
||||||
|
|
||||||
```bash
|
```bash
|
||||||
|
# Run all tests
|
||||||
pytest
|
pytest
|
||||||
|
|
||||||
|
# Run backend tests only
|
||||||
|
pytest backend/tests/
|
||||||
|
|
||||||
|
# Run frontend tests only
|
||||||
|
pytest frontend/tests/
|
||||||
```
|
```
|
||||||
|
|
||||||
|
### Available Environment Variables
|
||||||
|
|
||||||
|
| Variable | Description | Default |
|
||||||
|
| -------------------- | --------------------------- | ------------------- |
|
||||||
|
| `OPENROUTER_API_KEY` | Your OpenRouter API key | _Required_ |
|
||||||
|
| `ADMIN_EMAIL` | Default admin user email | `ai@allucanget.biz` |
|
||||||
|
| `ADMIN_PASSWORD` | Default admin user password | `admin123` |
|
||||||
|
| `DATABASE_URL` | DuckDB database path | `../data/app.db` |
|
||||||
|
|
||||||
## Default admin user
|
## Default admin user
|
||||||
|
|
||||||
On first startup a default admin account is created:
|
On first startup a default admin account is created:
|
||||||
@@ -79,17 +113,25 @@ Deployed on [Coolify](https://coolify.io) using Nixpacks. See [docs/deployment/c
|
|||||||
```txt
|
```txt
|
||||||
backend/ FastAPI backend
|
backend/ FastAPI backend
|
||||||
app/
|
app/
|
||||||
routers/ API route handlers
|
__init__.py Package initialization
|
||||||
services/ Business logic
|
db.py Database connection and operations
|
||||||
models/ Pydantic models
|
dependencies.py Dependency injection
|
||||||
tests/
|
main.py FastAPI application entrypoint
|
||||||
|
models/ Pydantic and database models
|
||||||
|
routers/ API route handlers (auth, users, admin, generate, gallery)
|
||||||
|
services/ Business logic for AI generation, users, admin, etc.
|
||||||
|
tests/ Backend test suite
|
||||||
frontend/ Flask frontend
|
frontend/ Flask frontend
|
||||||
app/
|
app/
|
||||||
|
__init__.py Package initialization
|
||||||
|
main.py Flask application entrypoint
|
||||||
templates/ Jinja2 HTML templates
|
templates/ Jinja2 HTML templates
|
||||||
static/ CSS, JS, images
|
static/ CSS, JS, images
|
||||||
tests/
|
tests/ Frontend test suite
|
||||||
data/ DuckDB database files (gitignored)
|
data/ DuckDB database files, uploaded media, and generated content
|
||||||
docs/ Architecture documentation
|
logs/ Application logs
|
||||||
|
docs/ Architecture documentation (arc42 template)
|
||||||
|
nginx/ Nginx configuration for Coolify deployment
|
||||||
```
|
```
|
||||||
|
|
||||||
## Documentation
|
## Documentation
|
||||||
|
|||||||
@@ -22,5 +22,5 @@ Any requirement that constrains software architects in their freedom of design a
|
|||||||
|
|
||||||
| Convention | Background / Motivation |
|
| Convention | Background / Motivation |
|
||||||
| -------------------- | --------------------------------------------------- |
|
| -------------------- | --------------------------------------------------- |
|
||||||
| Python 3.11+ | Modern language features, type hints |
|
| Python 3.12+ | Modern language features, type hints |
|
||||||
| pytest for all tests | Consistent test tooling across backend and frontend |
|
| pytest for all tests | Consistent test tooling across backend and frontend |
|
||||||
|
|||||||
@@ -29,7 +29,7 @@ Coolify's built-in reverse proxy routes traffic:
|
|||||||
3. Select the `ai.allucanget.biz` repository
|
3. Select the `ai.allucanget.biz` repository
|
||||||
4. Choose the `main` branch
|
4. Choose the `main` branch
|
||||||
5. Set **Build Pack** to `nixpacks`
|
5. Set **Build Pack** to `nixpacks`
|
||||||
6. **CRITICAL: Set Base Directory to `/backend`** — this tells Nixpacks to look in the `backend/` subdirectory for `requirements.txt` and the Python application
|
6. Set **Base Directory** to `/backend` - this tells Nixpacks to look in the `backend/` subdirectory for `requirements.txt` and the Python application
|
||||||
7. Set **Ports Exposed** to `12015`
|
7. Set **Ports Exposed** to `12015`
|
||||||
8. Set **Start Command** to:
|
8. Set **Start Command** to:
|
||||||
|
|
||||||
@@ -59,7 +59,7 @@ Add these as **Runtime** environment variables in Coolify:
|
|||||||
2. Select the same repository
|
2. Select the same repository
|
||||||
3. Choose the `main` branch
|
3. Choose the `main` branch
|
||||||
4. Set **Build Pack** to `nixpacks`
|
4. Set **Build Pack** to `nixpacks`
|
||||||
5. **CRITICAL: Set Base Directory to `/frontend`** — this tells Nixpacks to look in the `frontend/` subdirectory for `requirements.txt` and the Python application
|
5. Set **Base Directory** to `/frontend` - this tells Nixpacks to look in the `frontend/` subdirectory for `requirements.txt` and the Python application
|
||||||
6. Set **Ports Exposed** to `12016`
|
6. Set **Ports Exposed** to `12016`
|
||||||
7. Set **Start Command** to:
|
7. Set **Start Command** to:
|
||||||
|
|
||||||
|
|||||||
Reference in New Issue
Block a user