create-ntem-app
v1.0.7
Published
Boilerplate with Node, Typescript, Express, Mongoose to make RESTfull API in one go
Downloads
12
Maintainers
Readme
NTEM Boilerplate
NTEM Boilerplate is a Node.js application boilerplate for creating RESTful APIs using Mongoose, Express, and TypeScript. This boilerplate provides a structured and efficient setup to get your API project up and running quickly.
Table of Contents
Introduction
This boilerplate is designed to help you create RESTful APIs with Node.js, Express, Mongoose, and TypeScript. It includes common tools and configurations to streamline the development process and ensure best practices.
Features
- Modern Stack: Built with Node.js, Express, Mongoose, and TypeScript.
- Robust Architecture: Structured for scalability and maintainability.
- Pre-configured Tools: Includes ESLint, Prettier, and TypeScript configuration.
- Quick Setup: Initialize a new project with a single command.
Prerequisites
Make sure you have the following installed:
Quick initialize
To create a new application using this boilerplate, run:
npx create-ntem-app <your-app-name>
cd <your-app-name>
npm run dev
Or
npm init create-ntem-app <your-app-name>
cd <your-app-name>
npm run dev
Manual initialize
You love to do it in your way, Please follow these steps:
Clone repository:
git clone --depth 1 https://github.com/tushar1866/NTEM-Boilerplate.git
cd ntem-boilerplate
npx rimraf ./.git
Install the packages:
yarn install
Setup your environment variables:
cp .env.example .env
# to modify the environment variables open .env (if needed)
Inspired from https://github.com/hagopj13/node-express-boilerplate