https://github.com/tktcorporation/typescript-docker-template
base repository for developing typescript app with docker.
https://github.com/tktcorporation/typescript-docker-template
docker docker-compose editor editorconfig eslint github-actions mit-license prettier template typescript
Last synced: 3 months ago
JSON representation
base repository for developing typescript app with docker.
- Host: GitHub
- URL: https://github.com/tktcorporation/typescript-docker-template
- Owner: tktcorporation
- License: mit
- Created: 2020-07-12T01:15:54.000Z (almost 6 years ago)
- Default Branch: master
- Last Pushed: 2023-01-07T20:36:29.000Z (over 3 years ago)
- Last Synced: 2025-02-09T14:19:14.180Z (over 1 year ago)
- Topics: docker, docker-compose, editor, editorconfig, eslint, github-actions, mit-license, prettier, template, typescript
- Language: JavaScript
- Homepage:
- Size: 512 KB
- Stars: 0
- Watchers: 2
- Forks: 0
- Open Issues: 7
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
[](https://github.com/tktcorporation/typescript-docker-template/actions?query=workflow%3Atest)
# typescript-base
For creating a Typescript repository.
- [typescript-base](#typescript-base)
- [Tools](#tools)
- [Lint](#lint)
- [Format](#format)
- [Test](#test)
- [Build](#build)
- [Get Started](#get-started)
- [Building Docker](#building-docker)
- [Working in Docker container](#working-in-docker-container)
- [Installation](#installation)
- [Lint](#lint)
- [Format](#format)
- [Test](#test)
- [Build](#build)
## Tools
You can customize them easily.
- [Docker](https://www.docker.com/)
- [docker-compose](https://docs.docker.com/compose/)
### Lint
- [ESLint](https://eslint.org/)
### Format
- [Prettier](https://prettier.io/)
### Test
- [Jest](https://jestjs.io/)
### Build
- [tsc](https://www.typescriptlang.org/docs/handbook/compiler-options.html)
## Get Started
### Building Docker
```bash
$ docker-compose build
```
### Working in Docker container
```bash
$ docker-compose run app /bin/bash
```
### Installation
```bash
$ yarn
```
### Lint
```bash
# Find linting error and warnings
$ yarn lint
# Run lint fixing
$ yarn lint:fix
```
### Format
```bash
# Run format
$ yarn format
# This will return exit code 1 if all files are not formatted
$ yarn format:check
```
### Test
```bash
# unit tests
$ yarn test
# e2e tests
$ yarn test:e2e
# test coverage
$ yarn test:cov
```
### Build
```bash
# Run build
$ yarn build
```