generator-react-auth
Version:
Yeoman generator based on hutchgrant/react-boilerplate
80 lines (56 loc) • 3.23 kB
Markdown
# generator-react-auth [](https://travis-ci.org/hutchgrant/generator-react-auth)
> [Yeoman](http://yeoman.io) generator
## Getting Started
### What is Yeoman?
Trick question. It's not a thing. It's this guy:
Basically, he wears a top hat, lives in your computer, and waits for you to tell him what kind of application you wish to create.
Not every new computer comes with a Yeoman pre-installed. He lives in the [npm](https://npmjs.org) package repository. You only have to ask for him once, then he packs up and moves into your hard drive. _Make sure you clean up, he likes new and shiny things._
```bash
npm install -g yo
```
### Yeoman Generators
Yeoman travels light. He didn't pack any generators when he moved in. You can think of a generator like a plug-in. You get to choose what type of application you wish to create, such as a Backbone application or even a Chrome extension.
To install generator-react-auth from npm, run:
```bash
npm install -g generator-react-auth
```
Finally, initiate the generator(you can choose to configure environment):
```bash
$ mkdir awesome-app
$ cd awesome-app
$ yo react-auth
_-----_ ╭──────────────────────────╮
| | │ Welcome to the │
|--(o)--| │ hutchgrant/react-boilerp │
`---------´ │ late generator! │
( _´U`_ ) ╰──────────────────────────╯
/___A___\ /
| ~ |
__'.___.'__
´ ` |° ´ Y `
? If I may ask, what is your name? John Connor
? If I may ask, what is your email? rabidbadger@yourmail.com
? If I may ask, what is your GitHub? JC2029
? If I may ask, what name have you chosen for your new app? My Awesome App
? Would you like to set your environment now? Yes
? What is your MongoDB URI? mongodb://127.0.0.1/reactboiler
? What is your Redis address? 127.0.0.1
? What is your Redis Port? 6379
? What is your Google Invisible Recaptcha Key? https://www.google.com/recaptcha your-google-recaptcha-key
? What is your Google Invisible Recaptcha Secret? https://www.google.com/recaptcha your-google-recaptcha-secret
? What is your Google+ signin OAuth2.0 Client ID? https://github.com/hutchgrant/react-boilerplate/blob/master/docs/README_CONFIG.md#google-signin your-google-c
lient-id
? What is your Google+ signin OAuth2.0 Client Secret? https://github.com/hutchgrant/react-boilerplate/blob/master/docs/README_CONFIG.md#google-signin your-goog
le-client-secret
? What address do you want to redirect clients to who sign in to your API? http://localhost:3000
```
After completion you can start with:
```bash
npm run dev
```
By default you can view the app at http://localhost:3000
Documentation for the react-boilerplate project can be found on the [project's repository](https://github.com/hutchgrant/react-boilerplate).
This generator was generated by [generator-boilerplate-generator](https://github.com/ariporad/generator-boilerplate-generator) and then modified to scaffold with the react-boilerplate project.
## License
MIT