RESTful API using Node.js, Express, Mongoose & TypeScript

This is a boilerplate for building scalable and robust REST APIs using Node.js & TypeScript.

Table of Contents

• Prerequisites
• Features
• Getting Started
  • Installation
  • Available Routes
  • Available Scripts

Prerequisites

You need to install MongoDB either on your local machine or using a cloud service as mLab.

Features

• TypeScript as Language

• Framework: Express.js

• ODM: Mongoose

• Authentication & Authorization with JSON Web Tokens

• Easy configuration of environment variables thanks to dotenv

Getting Started

Installation

1. install the dependencies using npm install or npm i

2. Rename the file .env.example to .env

3. Start the app using npm run dev

4. After that, go to: http://localhost:3658/api/users

Available routes

Method	Resource	Description
POST	/api/users/register	Create a new user in the DB. You need to specify in the body the following attributes: firstname, lastname, email & password.
POST	/api/users/login	Sign in with the email & password. If it's successful, it then generates a token
GET	/api/posts	Returns the posts

Available scripts

• dev - To run the app without transpile,
• start - Build & run the transpiled app