Skip to content

Restful API for a cash management system using Django and Django Rest Framework.

License

Notifications You must be signed in to change notification settings

MohammadMahdi-Akhondi/cash_management

Repository files navigation

Cash management system

Restful API for a cash management system using Django and Django Rest Framework. The system allow users to manage their cash flow by creating and updating transactions, tracking balances, and generating reports.

Technologies

python django DRF docker postgresql github action

Setup project

  1. Clone the project repository:

    git clone https://github.com/MohammadMahdi-Akhondi/cash_management
    cd cash_management
  2. Setup virtual environment

    virtualenv .venv
    source .venv/bin/activate
  3. Install dependencies

    • for development(recommended):

      pip install -r requirements_dev.txt
    • for production:

      pip install -r requirements.txt 
  4. Build and launch the Docker environment

    • for development(recommended):

      docker compose -f docker-compose.dev.yml up -d --build
    • for production:

      docker compose up -d --build
  5. Run project for development stage:

    python manage.py runserver

Test and coverage

coverage run -m pytest
coverage report