1.0.0 • Published 4 years ago

poc-bff-service v1.0.0

Weekly downloads
-
License
ISC
Repository
github
Last release
4 years ago

bff-service

It's a Back End for Front End (BFF), connecting with API's and adjusting the necessary presentation logic for the front ends.

Requirements

  • nvm (Recommended)
  • node and npm (v10.16.3)

Environment Variables

We have some environment variables which are necessary to run the application. You can check them in the .sample-env file.

Running Locally

Ensure you have the correct node version. For example, if you are using nvm, you can simple run the following commands:

nvm install
nvm use

We are using private npm modules, don't forget to login first with the following command npm login.

And then you can install the application using npm install.

You need your own .env to run locally. For example:

AWS_BASE_URL=https://cdn.telecineplay.com.br/api
NODE_ENV=development

And, finally, you can run the following command npm run start:dev to run the application.

The application should be served on localhost:3000.

Running Tests

You can run all tests (as of moment, unit and integration) using the following command:

npm run test

To do Test-Driven Development, you can keep the unit tests on watch mode with the following command:

npm run test:unit:watch

Contact

Kill Bill Squad

Slack: #kill-bill-squad