https://github.com/nyancodeid/node-project-blueprint

NodeJS Project Blueprint (Babel 7 + Mocha + NYC + ESLint)
https://github.com/nyancodeid/node-project-blueprint

babel7 blueprint eslint mocha node nodejs nyc

Last synced: 3 months ago
JSON representation

NodeJS Project Blueprint (Babel 7 + Mocha + NYC + ESLint)

• Host: GitHub
• URL: https://github.com/nyancodeid/node-project-blueprint
• Owner: nyancodeid
• Created: 2020-08-08T13:55:03.000Z (about 5 years ago)
• Default Branch: master
• Last Pushed: 2021-08-01T03:39:26.000Z (about 4 years ago)
• Last Synced: 2025-04-05T11:31:10.907Z (6 months ago)
• Topics: babel7, blueprint, eslint, mocha, node, nodejs, nyc
• Language: JavaScript
• Homepage:
• Size: 98.6 KB
• Stars: 1
• Watchers: 2
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • Changelog: CHANGELOG.md

Awesome Lists containing this project

README

          
# NodeJS Project Blueprint

Getting started using NodeJS with bundled package you need.

![Project CI](https://github.com/nyancodeid/node-project-blueprint/workflows/Project%20CI/badge.svg)

[![dependencies Status](https://david-dm.org/nyancodeid/node-project-blueprint/status.svg)](https://david-dm.org/nyancodeid/node-project-blueprint)

[![devDependencies Status](https://david-dm.org/nyancodeid/node-project-blueprint/dev-status.svg)](https://david-dm.org/nyancodeid/node-project-blueprint?type=dev)

[![contributions welcome](https://img.shields.io/badge/contributions-welcome-brightgreen.svg?style=flat)](https://github.com/nyancodeid/node-project-blueprint/issues)

## Build In

- `Babel 7` as ES2020 Compiler.

- `Mocha` as Unit Testing.

- `NYC` as Code Coverage report.

- `ESLint` as Code Linter.

- `DotEnv` as env variable.

- `babel-module-resolver` as folder aliases.

## Aliases

| aliases  | folder        | description   |

| -------- | ------------- | ------------- |

| `@src/`  | `./src/`      | Source folder |

| `@test/` | `./__test__/` | Test folder   |

## Using

First you need clone this repository or download it.

Next, install all npm package dependecy

```bash

$ npm install

```

That's it. And to be clear this blueprint project is my workflow to getting done with nodejs project. I build this repository is for my self to match with my coding workflow after all.

## NPM Run Scripts

| script         | description                               |

| -------------- | ----------------------------------------- |

| `start`        | Start project with watch mode (nodemon)   |

| `start:server` | Build project and then run it             |

| `clean`        | Clean build project destination directory |

| `build`        | Build project                             |

| `lint`         | Run ESLint linting                        |

| `lint:fix`     | Run ESLint linting and auto fix           |

| `test`         | Run Mocha Unit Testing                    |

| `cover`        | Run code coverage test and report         |

## VS Code Extension

Here are my recommendations for VS Code Extension to make my workflow or maybe your workflow even better.

- [REST Client](https://marketplace.visualstudio.com/items?itemName=humao.rest-client)

- [Prettier](https://marketplace.visualstudio.com/items?itemName=esbenp.prettier-vscode)

- [ESLint](https://marketplace.visualstudio.com/items?itemName=dbaeumer.vscode-eslint)