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

Install the dependencies

Make sure 'make' is installed for your machine.

make install # to install python package
make npm-install # to install npm packges inside static folder
make migrate

# Adds default db data
make seed # migrate_mongodb.py and load_activities

Run the project:

Run Django development server

make serve

make serve env=local
make serve env=production

Run the vite developement server

make vite

Run the linter

make lint

Using Docker

Build the containers

make run-dependencies

Management

Management

Run Command in the containers

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

docker-compose -f docker-compose.dev.yml run --rm django make serve
docker-compose -f docker-compose.dev.yml run --rm django make migrate
docker-compose -f docker-compose.dev.yml run --rm django make migrations

# Vite app on the static
docker-compose -f docker-compose.dev.yml run --rm npm make vite-host
docker-compose -f docker-compose.dev.yml run --rm --service-ports make vite-host
#
docker-compose -f docker-compose.dev.yml run --rm npm make npm-install
docker-compose -f docker-compose.dev.yml run --rm npm make npm-build