Backend-End Challenge

ChatClass Back-End challange API implementation. There is a Postman collection and environment in docs folder. Import them in your Postman App to visualize the available endpoints.

This API is available at: https://chatclasschallenge.herokuapp.com.

Technologies used to implement the API:

NodeJs;
KoaJs;
MongoDB;
Mongoose;
Jest;
Docker;

Running the API with docker:

It is necessary to have Docker installed in your machine in order to run the following commands:

To start the API:

docker-compose up

To stop the API:

docker-compose down

Running the API without docker:

It is necessary to have a .env file containning the following variables:

DB_URL=
PORT=

To start the API:

npm start

Running tests:

Tests are automatically runned by docker when using compose up, but they can be ran manually using the following command:

npm run tests

Running the script to import Authors:

In order to run the import authors script, you need to execute the following command line: