Flowly API

Table of contents

• Description
• Getting started
  • Prerequisites
  • Installation
  • Deployment
  • Usage
  • Running tests
• Contributing
• Changelog
• Authors
• License

About

Flowly API - backend for project managing service. Developed with NestJS using PostgreSQL database.

Getting started

Prerequisites

• yarn npm i -g yarn or corepack enable
• Running servers:
  • PostgreSQL
  • Redis
  • RabbitMQ

Important

Node.js 18.x+ version must be installed in your OS.

Installation

1. Clone the repository

$ git clone https://github.com/stbestichhh/flowly-api.git

2. Install dependencies

$ yarn install

Deployment

Start the server to production

$ yarn build
$ yarn start:prod auth
$ yarn start:prod flowly
$ yarn start:prod notifications

Start server locally

$ yarn start:dev auth
$ yarn start:dev flowly
$ yarn start:dev notifications

Usage

See API docs by visiting http://localhost:<service_port>/api/docs

Running tests

Unit tests

$ yarn test

watch mode

$ yarn test:watch

End to end tests

This e2e tests are testing server api

$ yarn test:e2e

watch mode

$ yarn test:e2e:watch

Contributing

Please read CONTRIBUTING.md for details on our code of conduct, and the process for submitting pull requests to us.

Changelog

Project changes are writen in changelog, see the CHANGELOG.md.

We use SemVer for versioning. For the versions available, see the tags on this repository.

For the supported and unsupported versions, see the SECURITY.md.

Authors

• @stbestichhh

License

This project is licensed under the MIT License - see the LICENSE.md