https://github.com/tushar1866/ntem-boilerplate
Boilerplate with Node, Typescript, Express, Mongoose to make RESTfull API in one go
https://github.com/tushar1866/ntem-boilerplate
es2020 express jest-test mongoose node nodeboilerplate restful-api typescript
Last synced: about 1 year ago
JSON representation
Boilerplate with Node, Typescript, Express, Mongoose to make RESTfull API in one go
- Host: GitHub
- URL: https://github.com/tushar1866/ntem-boilerplate
- Owner: tushar1866
- License: mit
- Created: 2024-05-07T06:32:17.000Z (about 2 years ago)
- Default Branch: main
- Last Pushed: 2024-07-18T13:01:37.000Z (about 2 years ago)
- Last Synced: 2025-05-25T16:08:36.148Z (about 1 year ago)
- Topics: es2020, express, jest-test, mongoose, node, nodeboilerplate, restful-api, typescript
- Language: TypeScript
- Homepage:
- Size: 354 KB
- Stars: 11
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- Contributing: CONTRIBUTING.md
- License: LICENSE
- Code of conduct: CODE_OF_CONDUCT.md
Awesome Lists containing this project
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](#introduction)
- [Features](#features)
- [Prerequisites](#prerequisites)
- [Installation](#installation)
- [Usage](#usage)
- [Project Structure](#project-structure)
- [Contributing](#contributing)
- [License](#license)
## 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:
- [Node.js](https://nodejs.org/) (v14.x or later)
- [npm](https://www.npmjs.com/) or [yarn](https://yarnpkg.com/)
## Quick initialize
To create a new application using this boilerplate, run:
```sh
npx create-ntem-app
cd
npm run dev
```
Or
```sh
npm init create-ntem-app
cd
npm run dev
```
## Manual initialize
You love to do it in your way, Please follow these steps:
Clone repository:
```bash
git clone --depth 1 https://github.com/tushar1866/NTEM-Boilerplate.git
cd ntem-boilerplate
npx rimraf ./.git
```
Install the packages:
```bash
yarn install
```
Setup your environment variables:
```bash
cp .env.example .env
# to modify the environment variables open .env (if needed)
```
Inspired from https://github.com/hagopj13/node-express-boilerplate