https://github.com/guilhermebkel/typescript-project-template
:milky_way: A ready-to-use Typescript Project Template
https://github.com/guilhermebkel/typescript-project-template
eslint git git-karma jest typescript
Last synced: 2 months ago
JSON representation
:milky_way: A ready-to-use Typescript Project Template
- Host: GitHub
- URL: https://github.com/guilhermebkel/typescript-project-template
- Owner: guilhermebkel
- Created: 2020-06-20T14:03:07.000Z (over 5 years ago)
- Default Branch: master
- Last Pushed: 2021-12-20T22:39:19.000Z (almost 4 years ago)
- Last Synced: 2025-07-11T18:46:19.541Z (3 months ago)
- Topics: eslint, git, git-karma, jest, typescript
- Language: JavaScript
- Homepage:
- Size: 292 KB
- Stars: 0
- Watchers: 2
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
A ready-to-use Typescript Project Template 🌉
## 📌 Overview
That's a ready to use Typescript Project Template to help you creating typescript apps fastly since we know the most painful part of it is setting up a basic and useful environment.
## 🕋 What you are able to
**1. Path Aliases:** You can create path aliases following the example on tsconfig.json and package.json.
```ts
// Instead of doing that
import { App } from "./src/App"
// Do that
import { App } from "~/App"
```
**2. Tests:** You can create unit tests (App.spec.ts) and integration tests (App.test.ts).
```sh
# Run all tests
npm test
# Run integration tests
npm run test:integration
# Run unit tests
npm run test:unit
```
**3. Docker Resources:** You can add docker resources to your project using the docker-compose (docker-compose.yaml) file.
```sh
npm run dev:resources
```
**4. Git Hooks:** With help of Husky (.huskyrc.json), all Git Commits are verified by tests and the git commit linter in order to ensure they follow the Git Karma principles. Besides, all Git Pushes are verified by a full test pipeline.
**5. Code Style/Quality Assurance:** With help of ESLint (.eslintrc.json), all the code inside source folder are verified in order to make sure it follows the rules you have set.
## 🔧 Technologies
- Typescript
- Husky
- Lint Staged
- ESLint
- Jest
- Git Commit Message Linter
## 🚀 Getting started
### Development
1. Clone this repository
2. Start coding
```sh
# Use this command to test without settings up unit and integration tests
npm run dev
# Use this command to test with unit and integration tests
npm run test
```
### Production
1. Run the following commands
```sh
# Run all tests
npm run test
# Build application
npm run build
# Run built application
npm start
```