A boilerplate featuring common configurations, dependencies and functionality to provide a quick start for your next project.
- Node
v14.xv14.16at the time of this document creation- https://nodejs.org/en/download/
- Yarn
v2.xv2.4at the time of this document creation- https://yarnpkg.com/getting-started/install
- Clone or fork this repo
git clone https://github.com/designbystephen/node-boilerplate.git - Change to project root
cd my-project-directory - Install dependencies
yarn - Start writing code in
my-project-directory/src
| Command | Description |
|---|---|
yarn test |
Run unit tests |
yarn lint |
Run linter |
yarn build |
Build /src to /build directory |
yarn start |
Run application at /src/index |
- babel
- @babel/cli
- @babel/core
- @babel/node
- @babel/plugin-transform-runtime
- @babel/preset-env
- @babel/register
- dotenv (.env) support
- create-react-app style envrionment variables via
universal-dotenv
- create-react-app style envrionment variables via
eslint- airbnb core linting styles via
eslint-config-airbnb-base
- airbnb core linting styles via
mocha- Lightweight testing framework
expect- Jest style assertions
nock- Request interception useful for testing REST apis
husky- Linting at pre-commit
- customizable for other git hooks
- typical workspace settings configured in
.vscodewithin the project root
React
Typescript
Django
Laravel
Facebook
Microsoft
Google
Alibaba
D3
Tencent