Skip to content

Latest commit

 

History

History
50 lines (46 loc) · 1.36 KB

README.md

File metadata and controls

50 lines (46 loc) · 1.36 KB

Atlas 3.0 Backend

The tech stack used is Django with Django-Ninja package running on Python 3.12.

Setup guide

  1. Clone this repository

  2. Download Python 3.12 and create a virtual environment by running

    python3.12 -m venv venv
  3. Start the virtual environment

    On Unix/macOS

    source ./venv/bin/activate

    On Windows Command Prompt

    .\venv\Scripts\activate.bat

    On Windows Powershell

    .\venv\Scripts\activate.ps1
  4. Install the required packages

    python -m pip install -r requirements.txt
  5. Install PostgresSQL (can use the latest version or use version 14.0 which is the version used at the time of writing this guide)

  6. Start pgAdmin

  7. Connect to the local PSQL server and create a database atlas_3. Ensure encoding is UTF-8.

  8. Change directory to atlas_3

    cd atlas_3
  9. In root directory. Create a .env file with the following content:

    DB_USER=YOUR_DB_USERNAME (default postgres)
    DB_PASSWORD=YOUR_DB_PASSWORD (default postgres)
    DB_PORT=YOUR_DB_PORT (default 5432)
    
  10. Run the migrations for the database

    python manage.py migrate
  11. Start the server

    python manage.py runserver