deploymate / README.md
shakauthossain's picture
HF Space ReadMe error fix
21f7e8d
metadata
title: DeployMate Backend API
emoji: 🚀
colorFrom: indigo
colorTo: blue
sdk: docker
sdk_version: 0.104.1
app_file: app.py
pinned: false

DeployMate Backend

This is the backend service for DeployMate, built with FastAPI.

Features

  • RESTful API with FastAPI
  • Automated testing, linting, and type checking via GitHub Actions
  • Docker support for containerized deployment

Development

Setup

  1. Create and activate a virtual environment:
    python3 -m venv venv
    source venv/bin/activate
    
  2. Install dependencies:
    pip install -e .[dev]
    
  3. Run the development server:
    uvicorn app.main:app --reload
    

Testing

Run all tests:

pytest

Linting & Type Checking

flake8 app/ tests/
mypy app/

Docker

Build and run with Docker:

docker build -t deploymate-backend .
docker run -p 8000:8000 deploymate-backend