Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/tomchv/typescript-project-template
A simple template to easily start Node Typescript project
https://github.com/tomchv/typescript-project-template
ecmascript template typescript
Last synced: 4 months ago
JSON representation
A simple template to easily start Node Typescript project
- Host: GitHub
- URL: https://github.com/tomchv/typescript-project-template
- Owner: TomChv
- License: mit
- Created: 2020-08-10T19:16:37.000Z (over 4 years ago)
- Default Branch: master
- Last Pushed: 2023-03-05T10:12:37.000Z (almost 2 years ago)
- Last Synced: 2023-06-07T07:29:47.485Z (over 1 year ago)
- Topics: ecmascript, template, typescript
- Language: JavaScript
- Homepage:
- Size: 2.07 MB
- Stars: 4
- Watchers: 2
- Forks: 0
- Open Issues: 10
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# Typescript-project-template
A simple template to easily start Node Typescript project
I was basically using this template for myself, but I think it can be used by anyone who wants to start a typescript project without spending 10 years to configure it.
With that template, you can start coding instantly, that's cool no ? :blush:
> Finding new ways to be lazy is probably the most productive thing you've done
A developer citation for sure
## Getting started
Install dependencies, there is nothing more.
```shell script
npm install
```
You can verify if everything is working with `npm test` or `npm start`
## Content
The template integrates some basic tools to develop efficiently
### Linter
It is very important to respect rules when coding.
I'm using [eslint](https://eslint.org/) with [airbnb rules](https://airbnb.io/javascript/), configure it to fits your needs
Type `npm run lint` to show your error and `npm run lint:fix` to fix simple one.
### Prettier
To separate coding rules and codeStyle, I use a [prettier config](https://prettier.io/). It's a very cool tool to formatting your code like your want
### Tests
Test his code is essential, template integrated [Jest](https://jestjs.io/en/) test suites with typescript usage.
You can add new tests in the `tests` folder.
Type `npm run test` or `npm run test:watch` to use it.
> Watching more is very useful during test :)
### Dev integration
**Env**
Work with an environment is sometime an obligation, especially when you build API with Docker and some secrets keys ect...
Set and set your config in `.envrc` if you need some variables
**Github**
There is a `.github` folder where you can write your [Github Action](https://github.com/features/actions) and _Github assets_
You can also find `.gitignore`. He's configure for node projects.
**Hooks**
To prevent you from commit / pushing bad code, [husky](https://github.com/typicode/husky) is set to lint, build and run test on a commit.
If your work fails one of those steps, commit will be aborted :angry:
## Maintainer
- [Vasek - Tom C.](https://github.com/TomChv)