Made by Dylan Tavarès with ❤️

Full Documentation

Get started

With Docker 🐳

Requirements:

• Docker
• Docker-compose

Pre-config :

You must define your environement in project root .env and backend/.env files to configure docker containers.

➤ From root directory

docker-compose up -d 

ℹ️ use this command to re-build containers if you had edit them

docker-compose up -d --build

Default ports :

• UI : localhost:8080
• Django App : localhost:8085
• Adminer : localhost: 31730
• Mkdocs : localhost:5000

➤ Stop containers

docker-compose down

Without docker

Requirements:

• Mysql:5.6
• NodeJs > 15
• Python > 3.6
• Mkdocs-material

Pre-config :

You must define your environement in backend/.env file to make backend work.

Frontend VueJs :

➤ From root directory go in frontend directory

cd ICG/frontend/

➤ Install dependencies

npm install

➤ Run dev server with hotreload

npm run serve

Backend Django :

➤ Go in backend directory from root directory

cd ICG/backend/

➤ Create virtual environement

python3 -m venv venv

➤ Source venv

source ./venv/bin/activate

➤ Install python packages

pip install -r requirements.txt

➤ Run django migrations

python3 manage.py migrate

➤ Run dev server

python3 manage.py runserver <PORT>

Documentation Mkdocs :

➤ Go in docs directory from root directory

cd CGI/docs/

➤ Run server

mkdocs serve