hightech0827 / Node-Express-Server-with-TypeScript

MERN-Stack

Node Express Server with TypeScript

For help getting started with Node Express, view online documentation.

1. Setup Node

2. Clone the repo

$ https://https://github.com/asif-simform/MERN-Stack.git
$ cd MERN-Stack/backend

3. Install dependency

$ npm install

4. Starts the application in development using nodemon and ts-node to do hot reloading.

npm run dev

5. Starts the app in production by first building the project with npm run build, and then executing the compiled JavaScript at build/index.js.

npm run start

6. Builds the app at build, cleaning the folder first.

npm run build

7. Runs the jest tests once.

npm run test

8. Run the jest tests in watch mode, waiting for file changes.

npm run test:dev

9. Format your code.

npm run prettier-format

10. Format your code in watch mode, waiting for file changes.

npm run prettier-watch

📖 App architecture

• src
  • constants
  • db
  • middlewares
  • modules
    • users
  • routes
  • utils

💻 Built With

• NodeJS
• ExpressJS
• TypeScript

🎉 Features

• Minimal
• TypeScript v4
• Testing with Jest
• Linting with Eslint and Prettier
• Pre-commit hooks with Husky
• VS Code debugger scripts
• Local development with Nodemon

🛡️ License

This project is licensed under the MIT License - see the LICENSE file for details.

👨‍💻 Author

👤 Asif Vora

• Github: @asif-simform
• LinkedIn: @asif-vora
• Twitter: @007_dark_shadow
• Instagram: @007_dark_shadow

🍰 Contributing

• Please contribute using GitHub Flow. Create a branch, add commits, and open a pull request.

• Please read CONTRIBUTING for details.

🙏 Support

This project needs a ⭐️ from you. Don't forget to leave a star ⭐️