README.md

GraphFlow

Create, modify and execute workflows by editing graphs.

Code	Jest coverage
libs/common
libs/ng
apps/backend
apps/frontend

Note:
There are e2e tests, so the coverage for ng and frontend is not very representative.

App	Comment coverage
apps/backend
apps/frontend

Description

The purpose of GraphFlow is to be able to create workflows by editing graphs.

The graphs are composed of nodes that can be created and reused by many workflows. The nodes can be simple variables, execute some custom code or even be functions that themselves consist of a graph.

Context

This work was carried out as a final project for the 2023 bachelor's degree.

Requirements

To make this project working, the following conditions are required:

• NodeJS (>= 16)
• npm

Dev tools

• docker (optional)

Usage

Some commands to quickly run the code:

See all the other commands.

Install

Install the node packages:

npm install

Run the backend

Start a database:

docker-compose up db

Then run the backend:

npm run backend:start

See more backend commands.

Init and populate the database

To init the database and add some default data:

npx mikro-orm schema:fresh -r --seed DbBaseSeeder

This completely resets the database. All existing data is lost.

Run the frontend

npm run frontend:start

See more frontend commands.

Tests

To run the tests:

npm run test

To run the e2e tests:

npm run test:e2e

See more global commands.

Contribution

See the git flow to contribute.