Raks Technical Test API

API developed for the purpose of testing my technical knowledge in back-end development.

Goal

The goal is to develop an API in Node.JS with endpoints for Creating, Reading, Editing and Deleting information in the user table. As a bonus, create an endpoint that returns the user's location according to the registered address.

Installation

Requirements

Git
Node.js

Clone the repository

$ git clone https://github.com/pedrolucasD/node-backend-test.git

Access the cloned repository path

$ cd node-backend-test

Install dependencies

$ npm i

Create a .env file into root path like the follow example:

NODE_ENV=development
PORT=8080
API_KEY=e11ca31f-fb8c-4579-b6a7-fc20f8a50039
GOOGLE_API_URL='https://maps.googleapis.com/maps/api/geocode/json'
GOOGLE_API_KEY=

Create a config.js file into root/config/ path like the follow example:

require('dotenv').config();

module.exports = {
  development: {
    database: 'databaseName',
    username: 'userName',
    password: 'userPassword',
    dialect: 'dialect',
    port: DBPort,
    host: 'yourHost',
    dialectOptions: {
      decimalNumbers: true
    }
  }
}

After the DB is configured, run the migrations and seeds

npx sequelize db:migrate

npx sequelize db:seed:all

Run server

$ npm run dev

The server will run on the port set into .env file

How to use

With the server running, access the Swagger documentation that contains all the details of the existing endpoints and the tests.

http://localhost:8080/docs

Authorization

On the left side of the Swagger interface (http://localhost:8080/docs) there will be an authorization button where the API-KEY must be inserted. Any value can be inserted.

Technologies

Node.js
Swagger OAS3.0

Author

Pedro Soares

plucas.soarespinto@gmail.com