Sessions Schedule API

📃 Summary

This project was developed as a prerequisite in the selection process for a backend developer vacancy. The objective of the project is to provide an API so that professionals can provide days and times for sessions, in addition, so that customers can schedule their sessions according to the available slots of the professional.

👔 The Business Roles

In order to allow our professionals to manage their availability we need a system that manages slots of time.
Professionals need to set which days of the week they are going to be available and interval of time for each day.
Each slot has a duration of 1 hour and contains two availability periods of 30 minutes, Example: a professional that is going to be available Mondays from 8am to 11am will have all this slots:

8:00am	8:30am	9:00am	9:30am	10:00am

When a customer books a session we need to block slots in order to not have conflicts with other customers trying to book sessions at the same time. Looking at the example above if a client books a session starting 8:30am, professional will not be available at 8:30am and 9:00am since every session has a 1 hour duration.

▶️ Environment

A version of the application has been made available at the following link for testing purposes: http://scheduleapi-xyz.umbler.net
You can use Docker Compose to run the entire stack required for the application, if you are a docker user 🐳 More details below in the running section.
You can also run the application directly on your computer. Just have NodeJS 12+ installed and Mongodb 4+.

🔥 Getting Started

These instructions will get this project up and running in your machine or docker host.

🐳 Using Docker Environment

Clone the project:

$ git clone git@github.com:paulohenriq/Sessions-Schedule-API.git

Access the project folder

$ cd Sessions-Schedule-API

With the docker previously installed, just run the following command:

$ docker-compose up -d

See the structure of the 📄docker-compose.yml file for more infos.

Access to the mongodb database will be available at: mongodb://127.0.0.1:27017/zenklub

The host for accessing the API endpoints is: http://127.0.0.1:3000

Make sure everything is working fine by accessing the healthcheck endpoint: http://127.0.0.1:3000/health If everything went well, you will see something like:

{
  "health": true
}

💻 Using your computer

👋 Prerequisites

Node.js

NPM

Mongodb

🚀 Installing

Clone the project:

$ git clone git@github.com:paulohenriq/Sessions-Schedule-API.git

Access the project folder

$ cd Sessions-Schedule-API

⚠️ change the mongodb access information using the environment variables available in /configs 📁

Install all packages using NPM:

$ npm install

To execute in Development environment:

$ npm run dev

To execute in Production environment:

$ npm start:dist

🤖 API and Endpoints

The API has the following endpoints:

[POST] /v1/sessions: Endpoint to create professional availability.
[GET] /v1/sessions: Endpoint to obtain the availability of all professionals in the current week.
[GET] /v1/sessions/:professionalCode: Endpoint to obtain the availability in the current week of the professional informed by parameter.
[DELETE] /v1/sessions/:professionalCode: Endpoint to delete the professional's schedules.
[POST] /v1/sessions/schedule: Endpoint for scheduling a session from a customer to a professional.

For details on the endpoints access the Swagger file 📄available here.

You can use the following postman collection to make using the API easier

⚙️ Running the tests

To run the project code tests with only relevant information in the terminal, use the command:

$ npm run test

To run the project code tests with complete information on the terminal, use the command:

$ npm run test:verbose

To run unit tests only, use the command:

$ npm run test:unit

To run integration tests only, use the command:

$ npm run test:integration

To run the project code tests and view coverage information, use the command:

$ npm run test:ci

⚠️ Approaches taked that are not outlined in requirements

Registration of availability and session schedules are carried out only for the current week.
It is only possible to schedule a session for the day after the current one. For example, if today is Tuesday it is only possible to make appointments from Wednesday to Saturday of the current week.

🔋 Future improvements and features

😰 Endpoint to update availability information.
Validation of data before persisting on mongodb.
Allow exclusion of availability by slot or day of the week.
Increase test cases to minimize the number of bugs not discovered.
Implement integration tests to validate each enpoint for API.
Implement soft delete function to avoid permanently deleting from mongodb.
Implement seeds for popular database when starting the project for the first time.
And more, with more time 🙌