ReportHub from iMMAP

Staging app: Staging demo

Documentation: Technical Documentation

Setup the project locally

Clone the repo

git clone https://github.com/iMMAP/rh.git

Create a virtualenv

cd rh

virtualenv .venv
# OR
python -m venv .venv

Activate virtualenv

source ./.venv/bin/activate

Install poetry

install Poetry with:

pip install poetry

Create .env file

Create .env file by copying the sample file and update the values.

cp .env.sample .env

Generate secret key

python src/manage.py generate_secret_key

Copy the output of the above command and update the SECRET_KEY variable in .env file

Install the dependencies

Make sure 'make' is installed for your machine.

# to install python package
make install

# to install npm packges for compling sass and etc
make npm-install 

# Run the migrations
make migrate

Populate Initial Data

Populat the database with necessary data to start testing

# Adds default db data for testing
# The below command loads django fixtures data which is located in each django app. 
# rh/fixtures/<data>.json

make loaddata

Run the project:

Run Django development server.

The dev command will run a django dev sever and vite server in the same terminal.

make dev

Or launch them separately

make serve

make serve env=local
make serve env=production

Run the vite developement server

make vite

Run the linter

To check for linting erros and style formatting with ruff

make lint

Using Docker

Build the containers

Build and run docker images

# docker compose up -d --build
make docker-up 

Run Command in the containers

# Django app
docker exec -it django bash
docker compose run --rm django make loaddata

Platform Management

Management