Ecosyste.ms: Awesome

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

Awesome Lists | Featured Topics | Projects

https://github.com/michelbernardods/user-registration-restapi-mongodb

User registration restapi + Mongodb
https://github.com/michelbernardods/user-registration-restapi-mongodb

express javascript mongodb mongoose nodejs npm yarn

Last synced: 8 days ago
JSON representation

User registration restapi + Mongodb

Awesome Lists containing this project

README

        

Nodejs and MongoDB REST API Project Structure



Getting started |
Features |
Software Requirements |
How to install |
How to run |

```
ENGLISH
```
This is an example NodeJS application that works with MongoDB

## Getting started

This is a basic API skeleton written in JavaScript. Very useful to building a RESTful web APIs for your front-end platforms like Android, iOS or JavaScript frameworks (Angular, Reactjs, etc).

This project will run on **NodeJs** using **MongoDB** as database. I had tried to maintain the code structure easy as any beginner can also adopt the flow and start building an API. Project is open for suggestions, Bug reports and pull requests.

## Features

- Basic Authentication (Register/Login with hashed password).
- JWT Tokens.
- When the User create a register is generate a Token of authorization and the password is cryptography.
- Pre-defined response structures with proper status codes.
- Validations added.

## Software Requirements

- NodeJs
- MongoDb

## How to install

### Using Git (recommended)

#### Clone the project from github.
```bash
git clone https://github.com/michelbernardods/user-registration-restapi-mongodb.git
```

### Using manual download ZIP

1. Download repository
2. Uncompress to your desired directory

### Install npm dependencies

```bash
npm install or npm i
```

## How to run

### Running API server locally

```bash
npm run dev
```