https://github.com/CodelyTV/typescript-api-skeleton

🔷🌍 TypeScript API Skeleton: Bootstrap your new TypeScript backend project
https://github.com/CodelyTV/typescript-api-skeleton

back-end backend backend-api ci eslint github-actions jest node node-js nodejs supertest ts tsconfig typescript

Last synced: about 1 month ago
JSON representation

🔷🌍 TypeScript API Skeleton: Bootstrap your new TypeScript backend project

• Host: GitHub
• URL: https://github.com/CodelyTV/typescript-api-skeleton
• Owner: CodelyTV
• Created: 2021-07-06T14:36:28.000Z (about 3 years ago)
• Default Branch: main
• Last Pushed: 2023-08-06T19:44:22.000Z (about 1 year ago)
• Last Synced: 2024-06-01T00:38:48.951Z (3 months ago)
• Topics: back-end, backend, backend-api, ci, eslint, github-actions, jest, node, node-js, nodejs, supertest, ts, tsconfig, typescript
• Language: TypeScript
• Homepage: https://pro.codely.tv/library/de-javascript-a-typescript-128106/347481/about/
• Size: 472 KB
• Stars: 192
• Watchers: 8
• Forks: 38
• Open Issues: 0
• Metadata Files:
  • Readme: readme.md

Awesome Lists containing this project

• awesome - CodelyTV/typescript-api-skeleton - 🔷🌍 TypeScript API Skeleton: Bootstrap your new HTTP API backend with TypeScript (TypeScript)

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

```