https://github.com/jmrl23/express-template

A robust and user-friendly template for building Express applications. It comes with all the essentials to kickstart your project. Additionally, it's highly flexible, allowing you to effortlessly incorporate your own features and enhancements.
https://github.com/jmrl23/express-template

express express-template expressjs template

Last synced: about 1 year ago
JSON representation

A robust and user-friendly template for building Express applications. It comes with all the essentials to kickstart your project. Additionally, it's highly flexible, allowing you to effortlessly incorporate your own features and enhancements.

• Host: GitHub
• URL: https://github.com/jmrl23/express-template
• Owner: jmrl23
• Created: 2023-10-29T10:29:14.000Z (over 2 years ago)
• Default Branch: main
• Last Pushed: 2025-01-20T12:32:39.000Z (over 1 year ago)
• Last Synced: 2025-03-31T22:35:08.882Z (about 1 year ago)
• Topics: express, express-template, expressjs, template
• Language: TypeScript
• Homepage:
• Size: 299 KB
• Stars: 1
• Watchers: 2
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md

Awesome Lists containing this project

README

          
# Express Template

template for building express application

[![Express](https://i.cloudup.com/zfY6lL7eFa-3000x3000.png)](http://expressjs.com/)

## Installation

```sh

yarn # or npm install

```

## Scripts

| Script     | Description                                 |

| ---------- | ------------------------------------------- |

| build      | build project                               |

| test       | run test files                              |

| start      | start (must build first)                    |

| start:dev  | start on development mode (nodemon + swc)   |

| start:prod | start on production mode (must build first) |

| format     | format codes (prettier)                     |

| lint       | lint codes (eslint)                         |

## Structure

Core files and folders

```

src/

├── app.ts                        # main express instance

├── bootstrap.ts                  # main plugins entrypoint

├── init.ts                       # initialization file

├── lib/                          # libraries

│   ├── common/

│   │   ├── index.ts

│   │   ├── logger.ts

│   │   ├── swagger.ts

│   │   ├── typings.ts

│   │   ├── validate.ts

│   │   └── wrapper.ts

│   └── constant/

│       └── env.ts

├── main.ts                       # main entrypoint

├── modules/

│   ├── cache/

│   │   ├── cacheService.spec.ts

│   │   └── cacheService.ts

│   └── todos/                    # example module

│       ├── todos.route.ts

│       ├── todosSchema.ts

│       ├── todosService.spec.ts

│       └── todosService.ts

├── plugins/

│   ├── middlewares.ts

│   ├── routes.ts

│   └── swagger.ts

└── test.ts                       # test entrypoint (run all test files)

```