DBTex API

A FastAPI-based backend service for managing users and conversations, backed by PostgreSQL, Docker, and GitHub Actions CI/CD.

---

🚀 Features

• • User Management: Secure user registration & retrieval with hashed passwords.
• • JWT Authentication: OAuth2 password flow using jose.
• • Conversations & Memories: CRUD endpoints for storing user messages and LLM responses.
• • Voting System: Upvote/downvote conversations.
• • Dockerized: Development & production Docker Compose configurations.
• • CI/CD: Automated tests, Docker image build & push, Heroku & Ubuntu deployments via GitHub Actions.
• • Thematic README: This file!

---

📦 Project Structure

/home/siisi/dbtex-api
├── app
│   ├── config.py         # Pydantic settings
│   ├── database.py       # SQLAlchemy engine & session
│   ├── main.py           # FastAPI app creation & startup
│   ├── models.py         # SQLAlchemy ORM models
│   ├── routers
│   │   ├── auth.py
│   │   ├── conversation.py
│   │   ├── user.py       # User endpoints (with unique-email handling)
│   │   └── vote.py
│   ├── schemas.py        # Pydantic request/response models
│   └── utils.py          # Hashing & verification helpers
├── docker-compose-dev.yml # Dev compose (hot-reload, local Postgres)
├── docker-compose-prod.yml# Prod compose (image pull, nginx proxy via systemd)
├── Dockerfile            # Production image definition
├── .env                  # Dev environment variables
├── .env.prod             # Prod environment variables
├── README.md             # ← this file
└── .github/workflows
    └── build_deploy.yml  # CI: test, build, push, deploy

---

🔧 Local Development

1. Clone

   git clone git@github.com:YOUR_USERNAME/dbtex-api.git
   cd dbtex-api
   

2. Dev environment

   • Copy .env.example → .env and fill in your credentials.

   • Start services:

     docker compose -f docker-compose-dev.yml up --build
     

   • FastAPI available at http://localhost:8009 (mapped port)

   • Swagger UI: http://localhost:8009/docs

3. Database reset (dev only):

   docker compose -f docker-compose-dev.yml down -v
   docker compose -f docker-compose-dev.yml up --build
   

---

⚙️ Production Testing

1. Prepare .env.prod

   cp .env.prod.example .env.prod
   # Fill in your production values
   

2. Run compose

   docker compose -f docker-compose-prod.yml up -d --build
   

3. Verify logs

   docker compose -f docker-compose-prod.yml logs -f
   

4. Access via Nginx

   • Domain: https://dbtex-api.siisi.online
   • Ensure Nginx proxy targets the container port (e.g. 8001)

---

🛠 CI/CD Pipeline

• • On push or PR:
  1. Run pytest
  2. Lint & type-check (optional)
  3. Build & push Docker image to Docker Hub
  4. Deploy to Heroku & Ubuntu via SSH

Edit secrets in GitHub settings: OPENAI_API_KEY, ADMIN_DATABASE_URL, DOCKER_HUB_USERNAME, etc.

---

📝 API Endpoints

Method	Path	Description
POST	/users/	Create user (409 if email exists)
GET	/users/{id}	Retrieve user by ID
POST	/login	Obtain JWT token
GET	/conversation/	List conversations
POST	/conversation/	Create a conversation memory
PUT	/conversation/{id}	Update a memory
DELETE	/conversation/{id}	Delete a memory
POST	/vote/	Upvote/downvote a memory

Refer to the automatic docs at /docs for full schema details.

---

📚 Further Improvements

• Add pagination to list endpoints.
• Integrate Redis for caching heavy queries.
• Secure cookies & CSRF for browser-based clients.
• Add OpenAPI tags grouping and descriptions.

---

📄 License

MIT © 2025 Siisi