https://github.com/flow-build/diagrams

https://github.com/flow-build/diagrams

Last synced: 1 day ago
JSON representation

• Host: GitHub
• URL: https://github.com/flow-build/diagrams
• Owner: flow-build
• License: mit
• Created: 2022-08-11T12:32:41.000Z (almost 4 years ago)
• Default Branch: main
• Last Pushed: 2023-05-16T16:40:27.000Z (about 3 years ago)
• Last Synced: 2025-10-05T13:41:38.685Z (9 months ago)
• Language: JavaScript
• Size: 905 KB
• Stars: 0
• Watchers: 1
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • Changelog: CHANGELOG.md
  • License: LICENSE

Awesome Lists containing this project

README

          
# diagrams

diagrams is a service to manage BPMN diagrams.

![language](https://img.shields.io/github/languages/top/flow-build/diagrams)

[![Quality Gate Status](https://sonarcloud.io/api/project_badges/measure?project=flow-build_diagrams&metric=alert_status)](https://sonarcloud.io/summary/new_code?id=flow-build_diagrams) [![semantic-release: angular](https://img.shields.io/badge/semantic--release-angular-e10079?logo=semantic-release)](https://github.com/semantic-release/semantic-release)

## Environment variables

Add a .env file with the following variables:

- JWT_KEY (default = 1234)

- KNEX_ENV (suggested value = docker)

- NODE_ENV (suggested value = docker)

- POSTGRES_USER (default = postgres)

- POSTGRES_PASSWORD (default = postgres)

- POSTGRES_DB (default = diagrams)

- POSTGRES_HOST (default = localhost)

- POSTGRES_PORT (default = 5432)

- DIAGRAMS_LOG_LEVEL (default = info)

- CORE_LOG_LEVEL (default = info)

## Run the project on docker

To run app on docker, just run the command:

```

docker-compose up

```

Make sure ports 5000 and 5432 are free to use on your localhost.

## Tests

You can run tests by running: 

```

npm run test

```

Note: some tests will fail if you don't have the database running.

## Swagger

When the app is running along with the database you can access the following 

swagger to check out the API routes and test them yourself:

http://localhost:5000/swagger