https://github.com/jclagoria/test-project

https://github.com/jclagoria/test-project

Last synced: about 1 month ago
JSON representation

• Host: GitHub
• URL: https://github.com/jclagoria/test-project
• Owner: jclagoria
• Created: 2023-06-05T00:00:43.000Z (over 1 year ago)
• Default Branch: main
• Last Pushed: 2023-06-05T00:00:46.000Z (over 1 year ago)
• Last Synced: 2024-04-16T11:41:10.069Z (9 months ago)
• Language: TypeScript
• Size: 237 KB
• Stars: 0
• Watchers: 1
• 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:

  - [Codely's config](https://github.com/lydell/eslint-plugin-simple-import-sort/) (includes ESLint's recommended rules, Prettier, Import plugin and more)

  - [Jest plugin](https://www.npmjs.com/package/eslint-plugin-jest)

- [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

```