This project is Typescript + Express + Mongoose boilerplate.
These instructions will get you a copy of the project up and running on your local machine for development and testing purposes.
You need the following softwares to run this project:
- Node.js - Running javascript locally
npm
- Normally installed with Node.jsyarn
- Alternative tonpm
, recommended package manager
A step by step series of examples that tell you how to get a development env running
- Clone this repository
git clone https://github.com/chutipon29301/typescript-express-boilerplate.git
- Install dependencies
npm install // for npm
yarn // for yarn
To run tests only once, run:
yarn test
To run tests automatically while editing codes, run:
yarn test:watch
To format codes, run:
yarn format
- Express - The web framework used
- Npm or Yarn - Dependency Management
- MongoDB - NoSQL Database
- Mongoose - Object Data Modeling (ODM) library for MongoDB
Please read CONTRIBUTING.md for details on our code of conduct, and the process for submitting pull requests to us.