/IlyatooGraphApp

Enjoy a graph visualization of the Ilyatoo database

Primary LanguagePython

Ilyatoo graph vis

Code style: black code style: prettier

Enjoy a graph visualization of the Ilyatoo data.

Development guide

First, clone the repo:

git clone https://github.com/Tomansion/IlyatooGraphApp.git
cd IlyatooGraphApp

Backend

The backend is made with Python and requests / flask, it is based on a OpenAPI specification, check the OpenAPI specification for more information.

Requirements

  • Python v3.8
  • pip v23.1.2

How to setup

cd backend
pip install -r requirements.txt

Configuration

Fill the config file with your ArangoDB credentials.

Run the backend

python websrv.py

Check the SwaggerUI at http://localhost:3000/api/ui

Testing guide

Good practices

Check that your code is compliant with our linter Black:

black .

Frontend

The frontend is made with VueJS.

Requirements

  • NodeJS v19.0.0c
  • npm v8.19.2

How to setup

cd frontend
npm install

Run the frontend

npm run serve

The frontend is now available by connecting to the backend URL at http://localhost:3000

Good practices

Check that your code is compliant with our linter Prettier:

npm run prettier

Check that your code has no spelling mistakes:

npm run spellcheck

Recommended development environment