https://github.com/simplymichael/project-up

Quickly setup a Node.js application by answering a few simple questions.
https://github.com/simplymichael/project-up

cli create create-project git git-setup node npm project setup

Last synced: about 2 months ago
JSON representation

Quickly setup a Node.js application by answering a few simple questions.

• Host: GitHub
• URL: https://github.com/simplymichael/project-up
• Owner: simplymichael
• License: mit
• Created: 2021-01-11T16:09:55.000Z (almost 4 years ago)
• Default Branch: master
• Last Pushed: 2021-01-11T16:23:13.000Z (almost 4 years ago)
• Last Synced: 2024-10-10T23:41:25.830Z (3 months ago)
• Topics: cli, create, create-project, git, git-setup, node, npm, project, setup
• Language: JavaScript
• Homepage:
• Size: 112 KB
• Stars: 2
• Watchers: 2
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • Changelog: CHANGELOG.md
  • License: LICENSE.md

Awesome Lists containing this project

README

        
# Project UP

[![GitHub License](https://img.shields.io/github/license/simplymichael/express-user-manager)](https://github.com/simplymichael/project-up/LICENSE.md)

[![Conventional commits](https://img.shields.io/badge/Conventional%20Commits-1.0.0-brightgreen.svg)](https://conventionalcommits.org)

Quickly setup a Node.js application by answering a few simple questions.

## Installation

Install as a global module: `npm install -g project-up`

## Usage

`project-up [OPTIONS] `

If the project name is not given, it is derived from the name of the current working directory.

Remember to wrap in quotes if the project name is multi-word with spaces: `project-up "SIMPLE PROJECT"`.

## Options

- **-V**, **--version**: output version information

- **-v**, **--verbose**: enable verbose output

- **-l**, **--locale**: specify locale

- **-h**, **--help**: display command help

## Features

- Git setup (init + username and email configuration)

- NPM setup (init + install dependencies and dev dependencies)

- Test setup (with [Jasmine][jasmine] or [Mocha][mocha] + [chai][chai])

- Setup linting (using [ESLint][eslint] or [standard][standard])

- Setup conventional commits (using [commitizen][commitizen] and [cz-conventional-changelog][cz-conv])

- Setup coverage recording (with [nyc][nyc])

- Setup releasing (with [standard-version][standard-v])

- Setup pre-commit and pre-release hooks (with [ghooks][ghooks])

- Generate sample test

- Generate basic README file (with badges)

- Generate License File (using [lice][lice])

- Can be run on an existing git or npm project

## Running scripts in the generated project

First `cd` into the project directory, then run the appropriate script:

| Action                    | Usage                     |

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

| Linting code              | `npm run lint`            |

| Fix linting errors        | `npm run lint:fix`        |

| Commit staged changes     | `npm run commit`          |

| Run tests                 | `npm test`                |

| Run tests + code coverage | `npm run test:coverage`   |

| First release             | `npm run first-release`   |

| Subsequent releases       | `npm run release`         |

| Release dry-run           | `npm run release:dry-run` |

[chai]: https://npm.im/chai

[commitizen]: https://npm.im/commitizen

[cz-conv]: https://npm.im/cz-conventional-changelog

[eslint]: https://npm.im/eslint

[ghooks]: https://npm.im/ghooks

[jasmine]: https://npm.im/jasmine

[lice]: https://npm.im/lice

[mocha]: https://npm.im/mocha

[nyc]: https://npm.im/nyc

[standard]: https://npm.im/standard

[standard-v]: https://npm.im/standard-version