AI Platform

Pre-requisites

• docker Docker
• uv for Python package and environment management.

Project Setup

You can just fork or clone this repository and use it as is.

✨ It just works. ✨

Configure

Create env file using example file

cp .env.example .env

You can then update configs in the .env files to customize your configurations.

Before deploying it, make sure you change at least the values for:

• SECRET_KEY
• FIRST_SUPERUSER_PASSWORD
• POSTGRES_PASSWORD

### Generate Secret Keys

Some environment variables in the `.env` file have a default value of `changethis`.

You have to change them with a secret key, to generate secret keys you can run the following command:

```bash
python -c "import secrets; print(secrets.token_urlsafe(32))"

Copy the content and use that as password / secret key. And run that again to generate another secure key.

Boostrap & development mode

This is a dockerized setup, hence start the project using below command

docker compose watch

This should start all necessary services for the project and will also mount file system as volume for easy development.

You verify backend running by doing a health check

curl http://[your-domain]:8000/api/v1/utils/health/

or by visiting: http://[your-domain]:8000/api/v1/utils/health/ in the browser

Backend Development

Backend docs: backend/README.md.

Deployment

Deployment docs: deployment.md.

Development

General development docs: development.md.

This includes using Docker Compose, custom local domains, .env configurations, etc.

Release Notes

Check the file release-notes.md.

Credits

This project was created using full-stack-fastapi-template. A big thank you to the team for creating and maintaining the template!!!