Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/recallwei/express-ts-starter-template
Express TypeScript Starter Template is an opinionated Express/TypeScript/Prisma/PostgreSQL starter template.
https://github.com/recallwei/express-ts-starter-template
express nodejs opinionated postgresql prisma template typescript
Last synced: 12 days ago
JSON representation
Express TypeScript Starter Template is an opinionated Express/TypeScript/Prisma/PostgreSQL starter template.
- Host: GitHub
- URL: https://github.com/recallwei/express-ts-starter-template
- Owner: recallwei
- License: mit
- Created: 2022-07-23T07:35:33.000Z (over 2 years ago)
- Default Branch: main
- Last Pushed: 2023-08-18T04:47:42.000Z (over 1 year ago)
- Last Synced: 2024-11-07T05:06:02.905Z (12 days ago)
- Topics: express, nodejs, opinionated, postgresql, prisma, template, typescript
- Language: TypeScript
- Homepage:
- Size: 1 MB
- Stars: 3
- Watchers: 3
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- License: LICENSE
Awesome Lists containing this project
README
# EST
English / [简体中文](./README.zh-CN.md)
EST (Express Starter Template) is an opinionated `Express/TypeScript/Prisma/PostgreSQL` starter template.
## Features
- [x] Based on [Express](https://expressjs.com/)
- [x] [TypeScript](https://www.typescriptlang.org/), of course
- [x] [Prisma](https://www.prisma.io/) for ORM
- [x] JWT authentication and role based authorization
- [x] File service with `multer`
- [ ] Fully configured logger with [Winston] and [Morgan]
- [ ] Unit, Integration and E2E tests with [Jest] and [Supertest]
- [x] Linting with `ESLint`
- [x] Formatting with `Prettier`
- [x] Spelling check with `cspell`
- [x] Git commit management with `Husky`, `lint-staged` and `commitlint`
- [ ] Containerised with `Docker` and `Docker Compose`
- [x] Absolute path with `@/*`
## Tech Stack
- [Express](https://expressjs.com/)
- [TypeScript](https://www.typescriptlang.org/)
- [Prisma](https://www.prisma.io/)
- [PostgreSQL](https://www.postgresql.org/)
## Getting Started
### GitHub Template
> EST requires Node version >=14.16.0
[Create a repo from this template](https://github.com/recallwei/est/generate).
### Clone to Local
If you prefer to do it manually for a cleaner Git history, do the following:
```bash
npx degit recallwei/est my-est-app
cd my-est-app
pnpm i
```
## Checklist
When using this template, try to update your own information correctly according to the checklist:
- [ ] Clean up `README.md`
- [ ] Change author name in `LICENSE`
- [ ] Change project name, description, author, etc. in `package.json`
- [ ] Modify environment variables in `.env` and delete the file `.env.example` which is an example of environment variables
- [ ] Delete the example controller and route information in the `src/routes` directory
## Notice
- The file service will be saved in the `./storage` directory by default, which is added to `.gitignore` by default.
The directory can be reset by `FILE_STORAGE_PATH` in `.env`.
Don't forget to add the storage directory to `.gitignore` to prevent the stored files from being uploaded to GitHub.
## Usage
### Environment
- Node.js >=16.14.0
- pnpm
- PostgreSQL
### Config Environment Variables
Config `.env` file, refer to [.env.example](./.env.example).
### Install
```bash
pnpm i
```
### DB Migration
```bash
pnpm prisma:migrate
pnpm prisma:generate
pnpm prisma:seed
```
### Start
```bash
pnpm dev
```
### Build
```bash
pnpm build
```
## Known Issue
- [x] `chalk` v5.x doesn't work with `ts-node` well, use `chalk` v4.x instead.
- [x] Use `bcrypt.js` instead of `bcrypt` to avoid dependencies installing.
## License
[MIT](/LICENSE) License © 2023 [Bruce Song](https://github.com/recallwei)