sunhak-hout / express-ts-api-boilerplate

ExpressJS + Typescript (Boilerplate)

All you have been looking for with ExpressJS + Typescript + MongoDB:

• Simple Clean Code Structure
• Custom Error Handlings
• Module Aliases
• MongoDB Example
• Existing Sample Code

Getting Started

These instructions will get you a copy of the project up and running on your local machine for development and testing purposes. Feel free to play around ;)

Prerequisites

Make sure your NodeJS and NPM on your local machine is up to date.

node --version # v10.15.1
npm --verions  # 6.9.0

Installing and Running

Clone the project

git clone https://github.com/sunhak-hout/express-ts-api-boilerplate.git

Move into the project folder

cd express-ts-api-boilerplate

Config Environment Variables

cp .env.example .env
# set value of each variables in '.env' file

Install dependencies and start

npm install
npm run dev

Contributing

All pull requests and feedbacks are welcome and appreciated ;)

Author

• Sunhak Hout - Software Engineer - Bloo, Inc.

Acknowledgments

To all NodeJS and Typescript and other related field contributors, thank you! <3