# project-starter

> a cli tool to help you start a new project

Latest version **2.0.0** (published 2017-12-17) · MIT license · 0 weekly downloads

## Install

```sh
npm install project-starter
pnpm add project-starter
yarn add project-starter
bun add project-starter
```

Provides the command `project-starter`.

## Health

**Score 20/100 (F)** — status: abandoned.

Positive: esm support; no vulnerabilities.

Warnings: low downloads; no types.

Negative: abandoned; low maintenance score.

## Facts

| | |
|---|---|
| Version | 2.0.0 |
| Published | 2017-12-17 |
| First published | 2013-05-15 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | none |
| Module format | ESM + CommonJS |
| Node | >=6 |
| Dependencies | 13 |
| Known vulnerabilities | 0 |
| Install scripts | no |
| GitHub stars | 4 |
| Author | Noam Okman |
| Maintainers | sharongrossman, noamokman |
| Keywords | react, starter, generator, project |

## Links

- npm: https://www.npmjs.com/package/project-starter
- Repository: https://github.com/noamokman/project-starter
- Homepage: https://github.com/noamokman/project-starter#readme
- Issues: https://github.com/noamokman/project-starter/issues
- npm.io page: https://npm.io/package/project-starter

## Dependencies (13)

- [cpr](https://npm.io/package/cpr.md) ^3.0.1
- [pify](https://npm.io/package/pify.md) ^3.0.0
- [execa](https://npm.io/package/execa.md) ^0.8.0
- [caporal](https://npm.io/package/caporal.md) ^0.9.0
- [read-pkg](https://npm.io/package/read-pkg.md) ^3.0.0
- [write-pkg](https://npm.io/package/write-pkg.md) ^3.1.0
- [handlebars](https://npm.io/package/handlebars.md) ^4.0.11
- [p-catch-if](https://npm.io/package/p-catch-if.md) ^1.0.2
- [snake-case](https://npm.io/package/snake-case.md) ^2.1.0
- [title-case](https://npm.io/package/title-case.md) ^2.1.1
- [replace-in-file](https://npm.io/package/replace-in-file.md) ^3.0.0
- [update-notifier](https://npm.io/package/update-notifier.md) ^2.3.0
- [parse-github-url](https://npm.io/package/parse-github-url.md) ^1.0.2

## Alternatives

- [mobx-react](https://npm.io/package/mobx-react.md) — 2.8M weekly downloads
- [rc-tree](https://npm.io/package/rc-tree.md) — 2.6M weekly downloads
- [@react-oauth/google](https://npm.io/package/@react-oauth/google.md) — 1.3M weekly downloads
- [@wagmi/connectors](https://npm.io/package/@wagmi/connectors.md) — 877.0K weekly downloads
- [vee-validate](https://npm.io/package/vee-validate.md) — 836.4K weekly downloads

## Recent versions

- 2.0.0 (latest) — 2017-12-17
- 1.1.0 — 2017-11-28
- 1.0.0 — 2017-10-01
- 0.0.14 — 2015-02-18
- 0.0.13 — 2015-02-17
- 0.0.12 — 2014-12-16
- 0.0.11 — 2014-12-10
- 0.0.10 — 2014-10-16
- 0.0.8 — 2014-08-14
- 0.0.7 — 2014-03-10
- 0.0.6 — 2014-02-24
- 0.0.4 — 2013-10-10
- 0.0.3 — 2013-06-14
- 0.0.2 — 2013-06-13
- 0.0.1 — 2013-05-15

## README

# project-starter [![Build Status](https://travis-ci.org/noamokman/project-starter.svg?branch=master)](https://travis-ci.org/noamokman/project-starter)
a cli tool to help you start a new project

## Installation
``` bash
$ [sudo] npm install project-starter -g
```

### Preview
See the output of this project [here](https://github.com/noamokman/project-starter-sample)

## Features
The generated project uses the following technologies:

### Client
* [React](https://github.com/facebook/react) A declarative, efficient, and flexible JavaScript library for building user interfaces
* [React Router](https://github.com/rackt/react-router) Declarative routing for React
* [Redux](http://redux.js.org/) A predictable state container for JavaScript apps.
* [Axios](https://github.com/mzabriskie/axios) Promise based HTTP client for the browser and node.js
* [React Router Redux](https://github.com/reactjs/react-router-redux) Ruthlessly simple bindings to keep react-router and redux in sync
* [redux-axios-middleware](https://github.com/svrcekmichal/redux-axios-middleware) Redux middleware for fetching data with axios HTTP client
* [redux-simple-promise](https://github.com/alanrubin/redux-simple-promise) Promise middleware for Redux
* [Redux Dev Tools](https://github.com/gaearon/redux-devtools) DevTools for Redux with hot reloading, action replay, and customizable UI
* [Material-ui](http://www.material-ui.com) A Set of React Components that Implement Google's Material Design
* [redux-form](https://github.com/erikras/redux-form) to manage form state in Redux
* [styled-components](https://www.styled-components.com/) Use the best bits of ES6 and CSS to style your apps without stress
* [socket.io-client](https://github.com/socketio/socket.io-client) Realtime application framework (client)
* [redux-actions](https://github.com/reduxactions/redux-actions) Flux Standard Action utilities for Redux
* [redux-auth-wrapper](https://github.com/mjrussell/redux-auth-wrapper) Handling Authentication and Authorization with Routing and Redux
* [redux-sockets](https://github.com/SharonGrossman/redux-sockets) simplify the integration of socket.io with your redux application
* [reflexbox](https://github.com/jxnblk/reflexbox) React flexbox layout and grid system
* [loadable-components](https://github.com/smooth-code/loadable-components) React code splitting made easy

### Server
* [Express](http://expressjs.com) Fast, minimalist web framework for Node.js
* [Socket.io](https://socket.io/) Socket.IO enables real-time bidirectional event-based communication
* [Mongoose](http://mongoosejs.com/) mongodb object modeling for node.js
* [express-async-router](https://github.com/spatools/express-async-router) An Express Router wrapper which automatically manage Promise.
* [express-json-error-handler](https://github.com/noamokman/express-json-error-handler) Error handler for express JSON APIs
* [express-jwt](https://github.com/auth0/express-jwt) express middleware that validates a JsonWebToken
* [jsonwebtoken](https://github.com/auth0/node-jsonwebtoken) JsonWebToken implementation for node.js
* [express-static-gzip](https://github.com/tkoenig89/express-static-gzip) Simple wrapper on top of express.static, that allows serving pre-gzipped files
* [passport](http://passportjs.org/) Passport is authentication middleware for Node.js
* [mongoose-plugin-seed](https://github.com/omrilitov/mongoose-plugin-seed) Mongoose plugin to seed your models
* [socketio-jwt](https://github.com/auth0/socketio-jwt) Authenticate socket.io incoming connections with JWTs
* [nodemon](https://nodemon.io/) Nodemon is a utility that will monitor for any changes in your source and automatically restart your server
* [bunyan](https://github.com/trentm/node-bunyan) a simple and fast JSON logging module for node.js services
* [env-bunyan](https://github.com/SharonGrossman/env-bunyan) Bunyan wrapper with environment variables

### Utilities
* [Babel](http://babeljs.io) Javascript Transpiler
* [babel-preset-env](https://github.com/babel/babel-preset-env) automatically determine what to compile.
* [babel-minify](https://github.com/babel/minify) An ES6+ aware minifier
* [Webpack](http://webpack.github.io) Module bundling
* [webpack-compression-plugin](https://github.com/webpack-contrib/compression-webpack-plugin) Prepare compressed versions of assets to serve
* [Jest](https://facebook.github.io/jest/) to allow writing unit tests for the project.
* [Enzyme](https://github.com/airbnb/enzyme) Javascript testing utilities for React
* [Husky](https://github.com/typicode/husky) Git hooks made easy
* [lint-staged](https://github.com/okonet/lint-staged) Run linters on git staged files
* [ESLint](http://eslint.org) Code styling
* [Plop](https://github.com/amwmedia/plop) Micro-generator
* [Commitlint](https://github.com/marionebl/commitlint) Lint commit messages

## Usage

Bootstrap a new project repository with these steps:

* Clone your repository

* run `npm init` with your preferred values (if no package json is found, will run `npm init -y` for you)

* run `project-starter` in the folder

### CLI
``` bash
$ project-starter

   project-starter 0.0.0 - a cli tool to help you start a new project
     
   USAGE

     project-starter [path]

   ARGUMENTS

     [path]      Directory to initialize      optional      default: "/path/to/cwd"

   GLOBAL OPTIONS

     -h, --help         Display help                                      
     -V, --version      Display version                                   
     --no-color         Disable colors                                    
     --quiet            Quiet mode - only displays warn and error messages
     -v, --verbose      Verbose mode - will also output debug messages    
```

### Example
``` bash
git clone https://github.com/me/my-project
cd my-project
project-starter
```

## License

[MIT](LICENSE)

---
_Source: https://npm.io/package/project-starter · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._