DATABASE

Database and API Management

This guide explains how to set up, initialize, and manage the FireForm database.

Database Setup

To create the database file and initialize the tables, run the following command from the project root:

python -m api.db.init_db

Tip

After running this, you should see a .db file in the root of the project.

Running the API

Once the database is initialized, start the FastAPI server:

uvicorn api.main:app --reload

If successful, you will see: INFO: Uvicorn running on http://127.0.0.1:8000

Testing Endpoints

1. Open your browser and go to http://127.0.0.1:8000/docs.
2. Use the Swagger UI to test endpoints like POST /templates/create.
3. Click "Try it out", fill in the data, and click "Execute".

Database Visualization

The database file is excluded from Git to avoid conflicts. To visualize the database:

1. Install the SQLite3 Editor extension in VS Code.
2. Open the .db file directly.