felipefa / nui-challenge-api

Nui Full-Stack Coding Challenge

Nui Full-Stack Coding Challenge

This repo was made to deliver a coding challenge for a Full-Stack role at Nui Care.

Description

The idea is to provide a backend that shows the user what care services they are eligible for based on their situation.

Endpoints

The API has the following endpoints:

• GET /healthcheck: Returns the status of the API.

• GET /questions: Returns all the questions that can be used to determine the user's situation.

• GET /questions/:key: Returns a specific question based on the key provided.

• POST /eligibleServices: Returns which services are available for the user based on the answers provided.

The endpoints available from this API can be tested using the rest client of your choice, thought I recommend the Rest Client extension for VSCode. There are files defined in the restClient folder that can be used to test the endpoints.

How to run

Before running the application, you will need to get the service account file from the Firebase project from Nui. Then simply follow the steps below:

• Create a new .env file based on the .env.example file.

• Install the dependencies:

pnpm install

• Run the application:

pnpm run dev

How to run the tests

Simply run the following command:

pnpm run test

Technologies

The application was built using the following technologies:

• Fastify
• Firebase
• Jest
• Node.js
• Typescript
• Zod