https://github.com/rtewari056/node-typescript-boilerplate

Production ready REST API boilerplate using Express and TypeScript
https://github.com/rtewari056/node-typescript-boilerplate

authentication backend expressjs nodejs production rest-api typescript

Last synced: 3 months ago
JSON representation

Production ready REST API boilerplate using Express and TypeScript

• Host: GitHub
• URL: https://github.com/rtewari056/node-typescript-boilerplate
• Owner: rtewari056
• License: mit
• Created: 2023-09-13T05:46:28.000Z (almost 3 years ago)
• Default Branch: main
• Last Pushed: 2024-06-17T04:38:48.000Z (about 2 years ago)
• Last Synced: 2026-01-03T18:10:59.955Z (6 months ago)
• Topics: authentication, backend, expressjs, nodejs, production, rest-api, typescript
• Language: TypeScript
• Homepage:
• Size: 115 KB
• Stars: 0
• Watchers: 1
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

          


Ultimate Express and TypeScript Authentication API Boilerplate for production use


  


    

    

    

    

        

    

  




## 🖥️ Tech Stack

**Backend:**

![Node JS](https://img.shields.io/badge/Node.js-339933?style=for-the-badge&logo=nodedotjs&logoColor=white) 

![Express JS](https://img.shields.io/badge/Express.js-000000?style=for-the-badge&logo=express&logoColor=white) 

![TypeScript](https://img.shields.io/badge/typescript-%23007ACC.svg?style=for-the-badge&logo=typescript&logoColor=white) 

![JWT](https://img.shields.io/badge/json%20web%20tokens-323330?style=for-the-badge&logo=json-web-tokens&logoColor=pink) 

**Database:**

![MySQL](https://img.shields.io/badge/mysql-%2300000f.svg?style=for-the-badge&logo=mysql&logoColor=white) 

## ⚡️ Features

- [x] Register & login user

- [x] Verify user's email address

- [x] Passwords are encrypted

- [x] Send forgot password email

- [x] Reset password

- [x] Access and refresh token based authentication

- [x] Schema validation

## 📖 Prerequisites

In order to run the project you need `node>=16`, `npm>=8` and `MySQL>=8.0` installed on your machine.

## 🚩 Getting Started

### 1. Clone the `node-typescript-boilerplate` repository:

```bash

git clone https://github.com/rtewari056/node-typescript-boilerplate.git

```

### 2. Navigate into repo:

```bash

cd node-typescript-boilerplate

```

### 3. Install package dependencies

```bash

npm install

```

### 4. Rename `.env.example` into `.env` and put all creadentials.

### 5. Go to `src/keys` folder and generate OpenSSL RSA key pair by running the bash script in your terminal

### 6. Run project:

In the `root` directory, open a terminal session and run:

```bash

npm run serve:dev

```

### 7. Open your browser and go to `http://localhost:5000`

## 👤 Developer

[Rohit Tewari](https://github.com/rtewari056)

## 📬 Contact

If you want to contact me, you can reach me through below handles.







## 📃 License

Node TypeScript Authentication API Boilerplate is licensed under the MIT License.

### Show your support by 🌟 the project