Skip to content

Commit

Permalink
Update README.md
Browse files Browse the repository at this point in the history
  • Loading branch information
pshaddel authored Dec 7, 2024
1 parent 8398b7e commit 682c815
Showing 1 changed file with 14 additions and 0 deletions.
14 changes: 14 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -9,6 +9,20 @@

<b>A Boilerplate for Express Apps with Prisma</b>

This repo includes some features that are important to me:
- [ ] using Typescript
- [ ] Hot Reload in Development
- [ ] Using Docker for running Database
- [ ] Using a ORM/ODM for the Database(in this case Prisma)
- [ ] Linting
- [ ] Formatter
- [ ] Validator
- [ ] Testing(Both unit and integration)
- [ ] Using Conventional Commit(Forced by commitlint package)
- [ ] Having Git Hooks(using Husky => pre/post)
- [ ] Documentation(use TS Docs, JS Docs and typedoc package to turn them to html pages)
- [ ] Having a proper pipeline(install, build, lint, format, test)

## Prerequisites

Nodejs and NPM: You can install the latest version [here](https://nodejs.org/en/download)
Expand Down

0 comments on commit 682c815

Please sign in to comment.