https://github.com/corbaz/typescript-api-skeleton
typescript-api-skeleton
https://github.com/corbaz/typescript-api-skeleton
Last synced: about 1 year ago
JSON representation
typescript-api-skeleton
- Host: GitHub
- URL: https://github.com/corbaz/typescript-api-skeleton
- Owner: corbaz
- Created: 2022-12-03T12:31:15.000Z (over 3 years ago)
- Default Branch: main
- Last Pushed: 2022-12-03T12:31:17.000Z (over 3 years ago)
- Last Synced: 2025-02-09T01:39:43.307Z (over 1 year ago)
- Language: TypeScript
- Size: 286 KB
- Stars: 0
- Watchers: 0
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: readme.md
Awesome Lists containing this project
README
# TypeScript Express API Bootstrap (base / project starter)
This is a repository intended to serve as a starting point if you want to bootstrap a express API project in TypeScript.
## Features
- [TypeScript](https://www.typescriptlang.org/) (v4)
- [ts-node-dev](https://github.com/wclr/ts-node-dev)
- [Prettier](https://prettier.io/)
- [ESLint](https://eslint.org/) with:
- [Simple Import Sort](https://github.com/lydell/eslint-plugin-simple-import-sort/)
- [Import plugin](https://github.com/benmosher/eslint-plugin-import/)
- [Jest](https://jestjs.io) with [DOM Testing Library](https://testing-library.com/docs/dom-testing-library/intro)
- [GitHub Action workflows](https://github.com/features/actions) set up to run tests and linting on push
## Running the app
```
# install dependencies
npm install
# run in dev mode on port 3000
npm run dev
# generate production build
npm run build
# run generated content in dist folder on port 3000
npm run start
```
## Testing
### Jest with supertest
```
npm run test
```
## Linting
```
# run linter
npm run lint
# fix lint issues
npm run lint:fix
```