/bling-pipe

BlingPipe - A High Standard RESTFul API

Primary LanguageTypeScriptMIT LicenseMIT

BlingPipe

Nest Logo MongoDB Logo

A High Standard RESTFul API

GitHub license Heroku linux-image

The main objective was to integrate with Pipedrive and Bling platforms, saving results to MongoDB.

The project is hosted on Heroku, you can check it at the link below:

🔧 Prerequisite

To bring up the RESTFul API in your environment, you MUST first:

  • Have an account with Pipedrive
  • Have an account at Bling
  • Clone the repository
    • git clone git@github.com:wenderpmachado/bling-pipe.git
  • Install the dependencies
    • yarn install or npm install
  • Set the environment variables
    • Renaming the .env.example file to .env
    • Fill in the secret information

🚀 Running the app

# development
$ yarn start

# watch mode
$ yarn start:dev

# production mode
$ yarn start:prod

✔️ Test

The project has implemented unit tests:

# unit tests
$ yarn test

In addition, we can see the test coverage:

# test coverage
$ yarn test:cov

Test Image 1

👋 Stay in touch

📝 License

This project is under the MIT license. See the archive LICENSE for more details.