nikitabaranov / cn-mentor-dashboard

Codding Nomads Mentor Dashboard

This repository is a quick docker-based way to run the dashboard application locally.

Docker and Docker-compose are required to run this repository.

To check, please run next commands in you terminal:

docker --version
#example output
#Docker version 20.10.14, build a224086

docker-compose --version
#example output
#docker-compose version 1.29.2, build 5becea4c

Source code

You can find the source code the Frontend and Backend components in separate repositories:

• Frontend: cn-mentor-fe
• Backend: cn-mentor-be

Setup Codding Nomads access

The application will use credentials for login to the portal and extract information to present in the dashboard.

Use .env-template to create .env and fill in the credentials.

cp .env-template .env

For example:

CN_MOODLE_USERNAME:[email protected]
CN_MOODLE_PASSWORD:C0mpl!catedP@ssw0rd

Project commands

The repository has a Makefile with a collection of convenience commands, so you can ether use make ... command or the corresponding docker commands.

Start

Start all services in containers required for the Dashboard

make start

Stop

Stop and destroy all containers (Data will be preserved within Docker volume)

make stop

Tools

Start Mongo-Express a web UI for Mongo DB

make tools

Clean

Destroy all containers and clean up data volume

NOTE: You will lose all data entered to the system!

make clean