Simple Stateless MicroService

Table of Contents

• Project Overview
• Features
• Built with
• API Documentation
• API End Points
• Known Issues
• Installation
• Test
• Contributing
• License

Project Overview

MicroServices is the backend of build a Simple Stateless microservice in Nodejs, with three major functionalities - Authentication, JSON patching and Image Thumbnail Generation.it was built from scratch using JavaScript and Node.js

Features

• User login,
• JSON patching
• Image Thumbnail Generation

Built with

• JavaScript
• Node.js
• Express framework

API Documentation

POSTMAN API documentation here

API End Points

HTTPS	ENDPOINT	DESCRIPTION
POST	/users/login	Login User
POST	/jsonpatch	Apply the json patch to a json object
POST	/thumbnail	Generate Thumbnail

Known issues

Everything works as expected; However:

• This project is just a backend app, i.e. no frontend implementation.

Installation

• $ git clone https://github.com/oyedejipeace/microservices.git
• $ cd microservices
• $ npm i , to install dependencies
• Create .env file using the .env.sample file as a guide
• $ npm start:dev, to start the server Once the server starts-up, you can query the api at http://localhost:5000/ using the end points stated above.

Test

• $ npm test

Contributing

Feel free to 🍴 fork this repository

👯 Clone this repository to your local machine using https://github.com/oyedejipeace/microservices.git

Make Contributions

🔃 Create a new pull request using https://github.com/oyedejipeace/microservices/compare

License

• MIT license
• Copyright 2018 © Microservices