Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/elhanarinc/resource-challenge

Challenge written with Node.js/Express.js Framework
https://github.com/elhanarinc/resource-challenge

expressjs javascript mongodb mongoose nodejs

Last synced: 26 days ago
JSON representation

Challenge written with Node.js/Express.js Framework

Host: GitHub
URL: https://github.com/elhanarinc/resource-challenge
Owner: elhanarinc
License: gpl-3.0
Created: 2018-12-25T20:08:18.000Z (about 6 years ago)
Default Branch: master
Last Pushed: 2023-02-01T16:02:47.000Z (almost 2 years ago)
Last Synced: 2023-03-01T16:12:06.065Z (almost 2 years ago)
Topics: expressjs, javascript, mongodb, mongoose, nodejs
Language: JavaScript
Homepage:
Size: 404 KB
Stars: 2
Watchers: 2
Forks: 0
Open Issues: 6
Metadata Files:
- Readme: README.md
- License: LICENSE

Awesome Lists containing this project

README

# Nodejs Challenge

Coding challenge written with Node.js/Express.js Framework.

This project assumes you had already installed these tools:
1. [node.js](https://nodejs.org/en/)
2. [express.js](https://expressjs.com/)

Third party packages, tools, etc.
1. [dotenv](https://www.npmjs.com/package/dotenv) for reading environment variables.
2. [jsonwebtoken](https://www.npmjs.com/package/jsonwebtoken) for user authentication.
3. [bcrypt](https://www.npmjs.com/package/bcrypt) for password hashing.
4. [mongoose](https://www.npmjs.com/package/mongoose) for ORM.
5. [nodemon](https://www.npmjs.com/package/nodemon) for auto restarting and persistent uptime.

In order to use API, you need a mongodb instance which could be on local your machine or [mongoDB-Atlas](https://cloud.mongodb.com). After that you need to create four different collections.
* Collection used for `users` endpoint
* Collection used for `resource` endpoint
* Test replica of `users`
* Test replica of `resource`

I have used an `.env` file for the project in order to seperate `test` and `production` environments and sample configuration for sample `.env` file:

```
DB_CONN_USERNAME=user
DB_CONN_PASS=password

DB_CONN_URL=sample_mongo_url
DB_CONN_DBNAME=sample_database_name

DB_COLL_RESOURCE_TEST=resource-test
DB_COLL_RESOURCE_PROD=resource

DB_COLL_USERS_TEST=users-test
DB_COLL_USERS_PROD=users

JWT_SECRET=sample-jwt-secret
```

Below are the commands that is need for running the API:
* `npm start` for production
* `npm test` for running tests

There are different endpoints for this API:
1. `/users/register`
* This endpoint accepts *POST* request.
* If user data is not on db it hashes the password, inserts the user data into db and returns a **token**.
* Body Params:
```
{
"name": "deneme",
"email": "[email protected]",
"password": "deneme"
}
```

2. `/users/login`
* This endpoint accepts *POST* request.
* If user data is on db, it returns a **token**.
* Body Params:
```
{
"email": "[email protected]",
"password": "deneme"
}
```

3. `/users/info`
* This endpoint accepts *GET* request.
* This endpoint is for debug, checks the user info on the db.
* No body params, only `x-access-token` on header.

4. `/users/drop`
* This endpoint accepts *GET* request.
* This endpoint is for debug, clears `users` collection.
* No body params.

5. `/users/show`
* This endpoint accepts *GET* request.
* This endpoint is for debug, shows `users` collection.
* No body params

6. `/resource/insert`
* This endpoint accepts *POST* request.
* If the token is valid, it inserts the `number` parameter into user's `resource` data.
* Header: `x-access-token: {sample token}`
* Body Params:
```
{
"number": 1
}
```

7. `/resource/show`
* This endpoint accepts *GET* request.
* This endpoint shows `resource` collection.
* No body params, only `x-access-token` on header.

1. `/resource/drop`
* This endpoint accepts *GET* request.
* This endpoint is for debug, clears `resource` collection.
* No params.

**Useful information about project:**
```
* API URL: https://zeplin-challenge.herokuapp.com/
* Web Server: Heroku
* Database: MongoDB Atlas
* App Framework: Node.js/Express.js
* CI/CD: Codeship
* Test framework: Mocha and Chai
```

**References**
1. https://medium.freecodecamp.org/securing-node-js-restful-apis-with-json-web-tokens-9f811a92bb52
2. https://scotch.io/tutorials/test-a-node-restful-api-with-mocha-and-chai
3. https://blog.codeship.com/heroku-github-nodejs-deployment/