Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/tomansion/ilyatoographapp
Enjoy a graph visualization of the Ilyatoo database
https://github.com/tomansion/ilyatoographapp
Last synced: 9 days ago
JSON representation
Enjoy a graph visualization of the Ilyatoo database
- Host: GitHub
- URL: https://github.com/tomansion/ilyatoographapp
- Owner: Tomansion
- Created: 2024-02-10T13:12:55.000Z (9 months ago)
- Default Branch: main
- Last Pushed: 2024-02-10T23:05:23.000Z (9 months ago)
- Last Synced: 2024-02-11T15:44:08.969Z (9 months ago)
- Language: Python
- Size: 115 KB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# Ilyatoo graph vis
[](https://github.com/prettier/prettier)
Enjoy a graph visualization of the [Ilyatoo](https://ilyatoo.com/) data.
## Development guide
First, clone the repo:
```bash
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](./back/api.yaml) for more information.
#### Requirements
- Python v3.8
- pip v23.1.2
#### How to setup
```bash
cd backend
pip install -r requirements.txt
```
#### Configuration
Fill the [config file](./backend/config/config.ini) with your ArangoDB credentials.
#### Run the backend
```bash
python websrv.py
```
Check the SwaggerUI at [http://localhost:3000/api/ui](http://localhost:3000/api/ui)
[Testing guide](./backend/tests/README.md)
#### Good practices
Check that your code is compliant with our linter Black:
```bash
black .
```
### Frontend
The frontend is made with VueJS.
#### Requirements
- NodeJS v19.0.0c
- npm v8.19.2
#### How to setup
```bash
cd frontend
npm install
```
#### Run the frontend
```bash
npm run serve
```
The frontend is now available by connecting to the backend URL at [http://localhost:3000](http://localhost:3000)
#### Good practices
Check that your code is compliant with our linter Prettier:
```bash
npm run prettier
```
Check that your code has no spelling mistakes:
```bash
npm run spellcheck
```
### Recommended development environment
- VSCode with extensions:
- [Vetur](https://marketplace.visualstudio.com/items?itemName=octref.vetur)
- [Black](https://marketplace.visualstudio.com/items?itemName=lextudio.restructuredtext)
- [Cspell](https://marketplace.visualstudio.com/items?itemName=streetsidesoftware.code-spell-checker)
- [Prettier](https://marketplace.visualstudio.com/items?itemName=esbenp.prettier-vscode)