FastAPI and NEO4J Boilerplate

A simple starter for building RESTful APIs with FastAPI and NEO4J.

Features

• Python FastAPI backend.
• Neo4J database.
• Authentication
• Deployment

Using the application

To use the application, follow the outlined steps:

1. Clone this repository and create a virtual environment in it:

   uv venv
   

2. Install the modules listed in the requirements.txt file:

3. run neo4j instance on docker

   docker run \                                                                        
   --publish=7474:7474 --publish=7687:7687 \
    --volume=$HOME/neo4j/data:/data \
      neo4j
   

4. You also need to start your NEO4J instance locally or on Docker and create a .env.dev file. See the .env.sample for configurations.

Example for running locally NEO4J at port 7474:

      cp .env.sample .env.dev

5. Start the application:

     uv run main.py
   

The starter listens on port 8000 on address 0.0.0.0.

The Neo4j Database example