Skip to content

itsmohamadh/node-ts-api-starter

Repository files navigation

Node TypeScript Basic API

This is a practical API using Node, TypeScript. It can be used as a sample starter project aswell

explore the demo here

Technologies

  • Node
  • TypeScript
  • Nextjs v13.4.1
  • Main Packages: express, dotenv, mongoose, joi, reflect-metadata
  • Dev Dependency Packages: @types/express , @types/jest , @types/node , @types/supertest , jest , supertest , ts-jest , ts-node ,ts-node-dev: , typescript

Features

  • Decorated Logging Function
  • Supports Tests
  • Typescript Modules
  • Validation using Joi
  • Database Connection & CRUD operation using Mongoose

Installation

Add Environment Variables

Create .env from '.env.example' file and declare the project environment variables

Starting a development instance of the app

shell command for development
npm install

npm run dev
shell command for build
npm install

npm run build

npm run start
shell command for test
npm install

npm run test
Testing each individual route

Install Rest Client for vs code and use files in rest folder.

Installation (Production)

Deployment Guid

Screenshots

Cover

About

This is an updated practical API using Node, TypeScript. It can be used as a sample starter project aswell

Topics

Resources

Stars

Watchers

Forks

Contributors