Node Express Server with TypeScript
December 4, 2023 ยท View on GitHub
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
๐ 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
๐ค Mark Teves
- Github: @asif-simform
- Skype: @007_dark_shadow
๐ฐ Contributing
-
Please contribute using GitHub Flow. Create a branch, add commits, and open a pull request.
-
Please read
CONTRIBUTINGfor details.
๐ Support
This project needs a โญ๏ธ from you. Don't forget to leave a star โญ๏ธ