Git Product home page Git Product logo

nodejs_api's Introduction

Node.js Task

A microservice built in node.js express for SocialCops. It offers three different functionalities

  1. Token creation (Public)
  2. JSON Patching (Protected)
  3. Image Thumbnail Generation (Protected)

Out of these, only the first service can be used without any authentication. Rest two services need a token(signed by using HMAC + SHA256 algorithm) generated from the first service.

NOTE: Request to all these services are sent using POST request and x-www-form-url-encoded type.

Getting started with the service

  1. Install node.js version 8.x from https://nodejs.org/en/download/ and Postman from https://www.getpostman.com/
  2. Clone the repository using git clone -b master https://github.com/ashvinsharma/nodejs_api.git.
  3. Install all the necessary libraries using the command npm install.
  4. For security reasons file with details of database is not commited on git. So create a file .env in the root folder with the following contents,
SECRET_KEY=mysecretkey
DB_URL=mongodb://<username>:<password>@<db_url>:<db_port>/<db_name>
  1. Run npm start to start the project.
  2. Run Postman to send the requests or simply run npm test to initiate the test.
  3. For Javascript styling and linting run npm run lint to execute eslint on all .js files in the project.

nodejs_api's People

Contributors

ashvinsharma avatar

Watchers

James Cloos avatar  avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.