Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/irfnd/express-ts-boilerplate
A boilerplate/starter project for quickly building RESTful APIs using Express, Typescript and Prisma with some pre-built features.
https://github.com/irfnd/express-ts-boilerplate
compression cors dotenv eslint expressjs helmet husky lint-staged morgan prettier prisma typescript zod
Last synced: about 4 hours ago
JSON representation
A boilerplate/starter project for quickly building RESTful APIs using Express, Typescript and Prisma with some pre-built features.
- Host: GitHub
- URL: https://github.com/irfnd/express-ts-boilerplate
- Owner: irfnd
- License: mit
- Created: 2024-08-27T10:53:33.000Z (5 months ago)
- Default Branch: master
- Last Pushed: 2024-08-27T10:53:38.000Z (5 months ago)
- Last Synced: 2024-12-12T13:11:06.085Z (about 2 months ago)
- Topics: compression, cors, dotenv, eslint, expressjs, helmet, husky, lint-staged, morgan, prettier, prisma, typescript, zod
- Language: TypeScript
- Homepage:
- Size: 36.1 KB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# Express TS Boilerplate
A boilerplate/starter project for quickly building RESTful APIs using Express, Typescript and Prisma with some pre-built features.
## Features
- **Logging**: using [morgan](https://github.com/expressjs/morgan)
- **Environment variables**: using [dotenv](https://github.com/motdotla/dotenv)
- **Security**: set security HTTP headers using [helmet](https://helmetjs.github.io/)
- **CORS**: Cross-Origin Resource-Sharing enabled using [cors](https://github.com/expressjs/cors)
- **Compression**: gzip compression with [compression](https://github.com/expressjs/compression)
- **Git hooks**: with [husky](https://github.com/typicode/husky) and [lint-staged](https://github.com/okonet/lint-staged)
- **Linting**: with [eslint](https://eslint.org/) and [prettier](https://prettier.io/)
- **DB ORM**: Typescript ORM with [prisma](https://www.prisma.io)
- **Validations**: schema validation with [zod](https://zod.dev/)
## Get Started
- Clone this repo
```bash
git clone https://github.com/irfnd/express-ts-boilerplate
```
- Rename this boilerplate to whatever you want and move to that folder
```bash
cd
```
- Delete .git folder
- Reinitialize your git
```bash
git init .
git add .
git commit -m "Your initialize commit"
```
- Install all packages
```bash
npm install
```
or
```bash
yarn
```
- Project ready.
- You can push/publish to your own github by changing some configuration in `package.json` based on the configuration you want.
## Contributing
Contributions are what make the open source community such an amazing place to be learn, inspire, and create. Any contributions you make are **greatly appreciated**.
- Fork the Project
- Create your Feature Branch `git checkout -b feature/AmazingFeature`
- Commit your Changes `git commit -m 'Add some AmazingFeature`
- Push to the Branch `git push origin feature/AmazingFeature`
- Open a Pull Request
## License
Distributed under the [MIT](https://github.com/irfnd/express-ts-boilerplate/blob/master/LICENSE) License.