• Stars
    star
    145
  • Rank 254,144 (Top 6 %)
  • Language
    TypeScript
  • License
    MIT License
  • Created over 6 years ago
  • Updated over 2 years ago

Reviews

There are no reviews yet. Be the first to send feedback to the community and the maintainers!

Repository Details

node js typescript mongodb express generator yo

"Buy Me A Coffee"

Node.js Express API with TypeScript 4

CircleCI branch npm Plugin on redmine.org onix

Node.js Express API with TypeScript 4. Supports MongoDB See node-express-fast-progress if you need vanilla JS

Description

This generator will help you to build your own Node.js Express Mongodb API using TypeScript 4.

Project Introduction

Features

Authentication:
  • passport local strategy
  • jwt authentication
  • OAuth2.0 Server (Authorization code grant, Refresh token grant)
Session Storage:
  • MongoDB
  • Redis
Integration testing
  • mocha
  • chai
  • supertest

Requirements

  • node >= 14
  • npm >= 6
  • mongodb >= 4.0
  • typescript >= 4.0

Installation

First, install Yeoman and generator-node-express-typescript-api using npm (we assume you have pre-installed node.js).

npm install -g yo
npm install -g generator-node-express-typescript-api

Then generate your new project:

yo node-express-typescript-api

App skeleton

.
├── LICENSE
├── README.md
├── nodemon.json
├── package.json
├── src
│   ├── components
│   │   ├── Auth
│   │   │   ├── index.ts
│   │   │   ├── interface.ts
│   │   │   ├── service.ts
│   │   │   └── validation.ts
│   │   ├── User
│   │   │   ├── index.ts
│   │   │   ├── interface.ts
│   │   │   ├── model.ts
│   │   │   ├── service.ts
│   │   │   └── validation.ts
│   │   ├── index.ts
│   │   └── validation.ts
│   ├── config
│   │   ├── connection
│   │   │   └── connection.ts
│   │   ├── env
│   │   │   └── index.ts
│   │   ├── error
│   │   │   ├── index.ts
│   │   │   └── sendHttpError.ts
│   │   ├── middleware
│   │   │   ├── middleware.ts
│   │   │   └── passport.ts
│   │   └── server
│   │       ├── ServerInterface.ts
│   │       ├── index.ts
│   │       ├── server.ts
│   │       └── serverHandlers.ts
│   └── routes
│       ├── AuthRouter.ts
│       ├── UserRouter.ts
│       └── index.ts
├── swagger.json
├── swaggerDef.js
├── tsconfig.json
└── tslint.json

Running the API

Development

To start the application in development mode, run:

npm install -g nodemon
npm install -g ts-node
npm install -g typescript
npm install

Start the application in dev env:

nodemon

Start the application in production env:

Install ts pm2 and typescript compiler:

npm install -g pm2
pm2 install typescript

example start with scale on 2 core:

pm2 start ./src/index.ts -i 2 --no-daemon

Express server listening on http://localhost:3000/, in development mode The developer mode will watch your changes then will transpile the TypeScript code and re-run the node application automatically.

Testing

To run integration tests:

npm test

Set up environment

In root folder you can find .env. You can use this config or change it for your purposes. If you want to add some new variables, you also need to add them to interface and config object (Look src/config/index.ts)

Usage as OAuth2.0 Server

To use this generator as OAuth2.0 server you should implement client side, that will be handle your redirectUris and make requests to /auth/token/ route. Read more about OAuth2.0

Swagger

npm install -g swagger-jsdoc
swagger-jsdoc -d swaggerDef.js ./src/**/*.ts -o swagger.json

Swagger documentation will be available on route:

http://localhost:3000/docs

Alt Text

Getting To Know Yeoman

  • Yeoman has a heart of gold.
  • Yeoman is a person with feelings and opinions, but is very easy to work with.
  • Yeoman can be too opinionated at times but is easily convinced not to be.
  • Feel free to learn more about Yeoman.

More Repositories

1

nestjs-prisma-mongodb

Starter for Nest.js, Prisma ODM, MongoDB
TypeScript
62
star
2

aws-lambda-dynamodb-serverless-starter

It is a serverless application that uses AWS lambda, dynamodb, and api gateway. It is written in typescript and uses the serverless framework.
TypeScript
28
star
3

nestjs-prisma-pagination

Nest.js Prisma Paginator
TypeScript
18
star
4

nestjs-pipes

JavaScript library that provides pipe functions for Nest.js application.
TypeScript
9
star
5

Internship

JavaScript
6
star
6

deno-starter-kit

This generator will help you to build your own Deno Mongodb API using TypeScript
TypeScript
5
star
7

intership-template

template for intership
JavaScript
5
star
8

jquery_code_organization

My jQuery Code Organization Concept
JavaScript
4
star
9

openiframe

Build Iframe. Ignore X-Frame-Options, Content-Security-Policy, X-Content-Type-Options, X-Xss-Protection etc.
JavaScript
4
star
10

node-express-fast-progress

This generator will help you to build your own Node.js Express API
JavaScript
3
star
11

nestjs-prisma-postgresql

Starter for Nest.js, Prisma ODM, PostgreSQL
TypeScript
2
star
12

response-format

REST API response format based on some of the best practices
2
star
13

node.js

2
star
14

jquery-large-project

JavaScript
1
star
15

live-coding-interview

Simple Live Coding Interview Platform; Technical Assessment Tool
JavaScript
1
star
16

express-actions

Build a modified version of a actions that proxies its inputs from request parameters, and proxies its exits through the response.
JavaScript
1
star
17

is-number

This package is a simple utility to check if a value is a number. Repository
TypeScript
1
star