Getting Started

The Evidential suite has a backend API server (FastAPI) and a frontend web-app (NextJS).

Note

Note: See our Reading List for links to documentation on our open-source tech stack.

Backend

Follow the steps below to get a local development environment running.

1. Install Task.

2. Install Docker.

3. Check out the https://github.com/agency-fund/evidential-be repository:

   gh repo clone agency-fund/evidential-be
   cd evidential-be
   

4. Install dependencies (Atlas, uv, Python dependencies) by running:

   task install-dependencies
   

5. Run the unit tests:

   task test-airplane
   

6. Get familiar with the task runner. Most of the commands you will run are defined in Taskfile.yml. Run:

   task --list
   

7. Start the dev server:

   task start-airplane
   

   This will start the server at http://localhost:8000. It stores its state in a local Postgres instance, running in Docker, on localhost:5499.

8. Visit the local interactive OpenAPI docs page: http://localhost:8000/docs

9. Now set up the pre-commit hooks in your local git with:

   uv run pre-commit install
   

Frontend

See https://github.com/agency-fund/evidential-fe.