Skip to content

k33wee/fl-backend

Repository files navigation

FL-Backend

This is a Django app for FL-Backend. It provides instructions on how to set up a virtual environment, run Docker Compose for the database, migrate the database, and run the app.

Prerequisites

  • Python 3.x
  • Docker
  • Docker Compose

Setup

  1. Clone the repository:

    git clone <repository_url>

Using pip and venv

  1. Create a virtual environment:

    python3 -m venv venv
  2. Activate the virtual environment:

    • For Windows:

      venv\Scripts\activate
    • For macOS/Linux:

      source venv/bin/activate
  3. Install the required dependencies:

    pip install -r requirements.txt

Using uv package manager

  1. Install the uv package manager:

    pip install uv
  2. Create a uv virtual environment:

    uv venv
  3. Install the required dependencies:

    uv pip install -r pyproject.toml

Database Setup

  1. Start the database using Docker Compose:

    docker compose up -d
  2. Apply the database migrations:

    python manage.py migrate

    or

    uv manage.py migrate

Running the App

  1. Collect static files:

    python manage.py collectstatic

    or

    uv manage.py collectstatic
  2. Start the Django development server:

    python manage.py runserver

    or

    uv manage.py runserver
  3. Open your web browser and navigate to http://localhost:8000 to access the app.

About

No description, website, or topics provided.

Resources

Stars

Watchers

Forks

Releases

No releases published

Packages

 
 
 

Contributors