/back_end_assessment

Primary LanguageJavaScript

back_end_assessment

This is a backend assessment/task for SG made using NodeJS, Express, and SQLite for database. It features:

  • authorization
  • authentication
  • routers
  • error handling
  • static db class
  • constants
  • validation
  • regex
  • data pagination
  • data creation
  • data reading
  • data updating
  • data deleting
  • RESTful api's
  • encrypted passwords
  • environment variables
  • JSON Web Tokens
  • slightly enhanced security
  • and a bit more...

Run it

command:

$ npm run dev

output:

> back_end_assessment@1.0.0 dev
> nodemon index.js

[nodemon] 2.0.20
[nodemon] to restart at any time, enter `rs`
[nodemon] watching path(s): *.*
[nodemon] watching extensions: js,mjs,json
[nodemon] starting `node index.js`
We are live on http://localhost:8000
Connected to SQlite database.

Endpoints

/register

The /register endpoint is handled with a router that accepts a POST method with 2 body fields: email and password

example

{
  "email": "admin@admin.com",
  "password": "admin"
}

PS: /register endpoint is handled with a router to allow further customization for that route. eg: accepting a GET method and serving an HTML

/login

The /login endpoint is handled with a router that accepts a POST method with 2 body fields: email and password

example

{
  "email": "admin@admin.com",
  "password": "admin"
}

PS: After logging in, the service attaches the JWT in the authorization response header. /login endpoint is handled with a router to allow further customization for that route. eg: accepting a GET method and serving an HTML

/products

The /products endpoint is first handled with a router that reads the authorization header for the JWT

example

Authorization: Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJpZCI6IjUiLCJpYXQiOjE2NjYxMDI2NzIsImV4cCI6MTY2NzMxMjI3Mn0.ROmbb0IjLUoB1WIaghNZVZUdgFTWxd80Eqojzu3x670

IF authorization fails, the process is terminated and user is denied access to the route requested. OTHERWISE next middleware in line is called to handle the request.

PS: /products endpoint is unreachable, but it is a parent route and handled with an AUTHORIZATION router to allow further customization for that route, THEN it it calls next() to pass the request to the next middleware. eg: accepting a GET method and serving an HTML

Method Route Example
POST /create http://localhost:8000/products/create
GET /read http://localhost:8000/products/read
PUT /update http://localhost:8000/products/update
DELETE /delete http://localhost:8000/products/delete

  • Template for /create

    {
  "name": "Bulb",
  "description": "Electric utility that emits light"
}

  • Template for /read

    URL: http://localhost:8000/products/read
or
URL: http://localhost:8000/products/read?page=0
or
URL: http://localhost:8000/products/read?limit=10
or
URL: http://localhost:8000/products/read?limit=2&page=5

  • Template for /update

    {
  "id": 2,
  "name": "Bulb",
  "description": "Electric utility that emits light"
}

  • Template for /delete

    {
  "id": 3
}

WARNING

IF YOU ENCOUNTER THIS PROJECT AND YOU ARE A LEARNER, DO NOT EXPOSE YOUR PRIVATE KEYS LIKE I DID IN THE .ENV FILE. FURTHER MORE, I ADJUSTED THE .GITIGNORE FILE INTENTIONALLY TO INCLUDE THE .ENV FILE IN MY COMMITS, THAT IS NOT A GOOD PRACTICE NOR RECOMMENDED. YOU HAVE BEEN WARNED.