Complete project template for building RESTful API with Typescript
Report Bug
·
Request Feature
Table of Contents
Building project with standardized structure could save much our time. We could focus on business process without considering too much on project structure. On the other hand, a good project structure should be clean, nice refactored, and easy to maintain.
Here's why:
- Your time should be focused on creating something amazing. A project that solves a problem and helps others.
- You shouldn't be doing the same tasks over and over like structuring project
- You should implement dry principles to the rest of your life
Of course, no one template will serve all projects since your needs may be different. So I'll be adding more in the near future. You may also suggest changes by forking this repo and creating a pull request or opening an issue. Thanks to all the people have contributed to expanding this project template!
This project structure is built using
- Everything is modular and unit testable
- Typescript everything
- Express API with dependency injected routes, controllers, repositories, middleware, and services
- Centralized configuration loading and validation
├── .husky/ # Pre-commit config for lint staged
├── src/ # All application source
├──── @types/ # Type definition
|
├──── api/
├────── controllers/ # Define all controllers
├────── helpers/ # Define all helpers
├────── lib/
├──────── logger.ts # Define logger
├────── middlewares/
├──────── authorization.ts # Define authorization using JWT
├──────── morgan.ts # Define morgan
├────── models/ # Define all schema models
├────── repositories/ # Define all repositories
├────── routes/
├──────── v1/ # Define all v1 routes
├────── services/ # Define all services
├────── validations/ # Define all controller validations
|
├──── config/
├────── swagger/ # Define swagger configuration
├────── database.ts # Define postgres database connection
├────── express.ts # Define express configuration
|
├──── constants/ # Define all constants
├──── server.ts # Create express config
├──── index.ts # ENTRYPOINT - Start server
|
├── test/ # End-to-end test
|
└── Lots of random build-related files
To start project, just clone this repo or Use this template
Before installation, make sure you have the following prerequisites
- NPM
npm install npm@latest -g
- Postgresql server
- Clone the repo or simply select use this template
git clone https://github.com/arifintahu/project-structure-api.git
- Install NPM packages
npm install
- Create .env file in main directory
touch .env
- Write the following example environment
NODE_ENV=development PORT=3001 DB_HOST=localhost DB_NAME=test DB_USER=postgres DB_PASS=postgres DB_PORT=5432 DB_LOG=true
- Test and build the project
npm run build
- Run the server
npm run start
Contributions are what make the open source community such an amazing place to learn, inspire, and create. Any contributions you make are greatly appreciated.
If you have a suggestion that would make this better, please fork the repo and create a pull request. You can also simply open an issue with the tag "enhancement". Don't forget to give the project a star! Thanks again!
- Fork the Project
- Create your Feature Branch (
git checkout -b feature/feature-name) - Commit your Changes (
git commit -m 'Add some feature-name') - Push to the Branch (
git push origin feature/feature-name) - Open a Pull Request