Inscrypt Nodejs Server

This is the Backend Server for the Inscrypt Wallet financial solution linking the communications between the mobile app and the web wallet with the company's business logic and its Database.

Getting Started

To run the project:

first and foremost clone or fork the GitRepo and orient your terminal to the root Dir, run npm install to install the needed node modules (if the node_modules folder already exists please delete it first).
Finally and after installing the needed node modules you can proceede with executing the Command npm start. if the prerequisites are all met the project sure be running perfectly.

Prerequisites

Node.js
Node Package Manager (npm)
Mongodb
Postman for testing Requests

Installing

Linux

  1. sudo apt-get install nodejs
  2. sudo apt-get install npm
  3. sudo apt-get install mongodb

Deployment

Server Image available at : Live Inscrypt Server Link

Server Paths (/Routes)

Users (/users):

This the general route to all User related paths , servers also as a way to get all users form the database.

Paramaters (POST):
- email
- password
- firstName
- lastName
- phoneNumber
- address:{
  - country,
  - city,
  - street,
  - houseNumber }
P.S : * if the Resquest is POST then it's a SignUp route if GET then it views all users in the database * all the upcoming user related routes starts with /users:

Login (/users/login):

This is the basic Login (POST) Request

Parameters:
- email: user email.
- password: user password.

fetch (/users/fetch):

This is a GET request to get a certain user

Parameters:
- Header: authorization

Versioning

We use SemVer for versioning.

Authors

Missaoui Mounir - Initial work - BlastillROID

See also the list of contributors who participated in this project.

License

This project is licensed under the MIT License - see the LICENSE.md file for details

What's next

Documenting the rest of the routes and debugging the codes including the blockchain Business logic

BlastillROID / InscryptBack