https://github.com/flow-build/engine
https://github.com/flow-build/engine
Last synced: about 1 year ago
JSON representation
- Host: GitHub
- URL: https://github.com/flow-build/engine
- Owner: flow-build
- License: mit
- Created: 2020-03-17T15:11:44.000Z (over 6 years ago)
- Default Branch: master
- Last Pushed: 2024-01-10T12:55:28.000Z (over 2 years ago)
- Last Synced: 2025-03-29T00:12:58.456Z (about 1 year ago)
- Language: JavaScript
- Size: 3.88 MB
- Stars: 5
- Watchers: 2
- Forks: 6
- Open Issues: 9
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- License: LICENSE
- Security: .github/SECURITY.md
Awesome Lists containing this project
README
FlowBuild Engine
workflow manager for your project
[](https://github.com/semantic-release/semantic-release)
[](https://codecov.io/gh/flow-build/engine)
[](https://www.npmjs.com/package/@flowbuild/engine)
[](https://github.com/flow-build/engine/actions?query=workflow%3A%22Node.js+CI%22)
## Dependencies:
```
node v16.15
npm v8.5.0
```
## Run the project:
### On Docker:
To run tests on docker, you may use the command below:
```
docker-compose run -T app ./scripts/run_tests.sh
```
To setup the docker environment, you may run `docker-compose build` followed by `docker-compose up`.
Running `docker-compose up` will setup two containers (Application and Database Server) and run the migrations.
Once the commands above have been executed, you may run `docker exec -it workflow_app /bin/bash` to gain access to a bash inside the container of the Application. To run the tests, you may use the commands below.
To run tests with PostgreSQL database persistence:
```
npm run tests
```
To run tests with memory persistence:
```
npm run tests-memory
```
### On your localhost:
Run the commands below to setup your environment and run the tests to verify that your environment was correctly built.
```
psql -f scripts/sql/create_database.sql
npm install
npm run migrations
npm run tests
npm run tests-memory
```
## Running the examples:
First, install all the dependencies with `npm install`. The examples run with memory persistence option by default.
To run the examples from the root path of the project, you may run a command like the one below:
```
node examples/.js
```
## Contributing
Read [CONTRIBUTING](.github/CONTRIBUTING.md) guide.