🚀 Synapse - Backend

⚙️ How to Run the Project

Run project in localhost

Follow these steps to set up and run the application in your local environment.

📦 1. Clone the project

git clone https://github.com/Grupo-Syntax-Squad/synapse-backend.git
cd synapse-backend

🐍 2. Create a virtual environment

python -m venv .venv
source .venv/bin/activate   # Linux/Mac
.venv\Scripts\activate     # Windows

📥 3. Install dependencies

pip install -r requirements.txt

⚙️ 4. Database configuration

Create a .env file in the root directory:

DATABASE_URL=postgresql://postgres:password@localhost:5432/synapse

▶️ 5. Run the application

uvicorn app.main:app --reload

By default, the API will be available at:
👉 http://localhost:8000

---

🧹 6. Code quality

Check types with Mypy

mypy app/

Lint and formatting with Ruff

ruff check .
ruff format .

Run project in docker environment

Dependencies

• docker-compose

sudo docker-compose up -d --build