https://github.com/wendelladriel/node-amazing-boilerplate
An amazing, simple and powerful Node boilerplate
https://github.com/wendelladriel/node-amazing-boilerplate
boilerplate eslint express flow husky jest nodejs
Last synced: 6 months ago
JSON representation
An amazing, simple and powerful Node boilerplate
- Host: GitHub
- URL: https://github.com/wendelladriel/node-amazing-boilerplate
- Owner: WendellAdriel
- Created: 2017-08-10T11:21:52.000Z (about 8 years ago)
- Default Branch: master
- Last Pushed: 2017-10-02T18:21:59.000Z (about 8 years ago)
- Last Synced: 2025-03-31T01:51:12.275Z (7 months ago)
- Topics: boilerplate, eslint, express, flow, husky, jest, nodejs
- Language: JavaScript
- Size: 45.9 KB
- Stars: 17
- Watchers: 2
- Forks: 7
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# Node Amazing Boilerplate
> An amazing, simple and powerful Node boilerplate
This project is built with **[Backpack](https://github.com/jaredpalmer/backpack)** and configured to use:
- **[Express](https://expressjs.com/)**
- **[ESLint](https://eslint.org)**
- **[Jest](https://facebook.github.io/jest/)**
- **[Flow](https://flow.org/)**
- **[Husky](https://github.com/typicode/husky)**
## How to use
- Clone this **repo** and enter it
- If you don't have **[Yarn](https://yarnpkg.com)** installed yet, install it
```
npm i -g yarn
```
- Install the **dependencies**
```
yarn
```
## Commands available
- To start the application in development mode use
```
yarn dev
```
- To run **Flow** use
```
yarn flow
```
- To run **ESLint** use
```
yarn lint
```
- To run the tests use
```
yarn test
```
- To run the tests in watch mode use
```
yarn test:watch
```
- To build the application for production use
```
yarn build
```
- To start the application in production mode use
```
yarn start
```
## Git Hooks
This project uses **Husky** to create and manage Git hooks, it already comes with two hooks configured:
- Before you commit and before you push your changes it will run: **ESLint**, **Flow** and **Jest** tests
- If you want to, you can configure other hooks, edit or even delete the existing ones.