forked from infinitered/ignite
-
Notifications
You must be signed in to change notification settings - Fork 0
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Moves ignite-cli into main directory, removes lerna, renames to Ignit…
…e CLI everywhere
- Loading branch information
1 parent
e884af6
commit 769f2a7
Showing
110 changed files
with
196 additions
and
571 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,17 +1,19 @@ | ||
|
||
# Contributing to Ignite | ||
# Contributing to Ignite CLI | ||
|
||
[](http://standardjs.com/) [](https://semaphoreci.com/ir/react_native_base) | ||
|
||
We welcome all contributors to Ignite! This contributing guide will help you get up and running to submit your first pull request. | ||
We welcome all contributors to Ignite CLI! This contributing guide will help you get up and running to submit your first pull request. | ||
|
||
Before submitting a pull request, you will want to make sure that your branch meets the following requirements: | ||
|
||
_These examples assume you're using yarn rather than npm. If you're not using yarn, replace these commands with the [appropriate npm alternative](https://shift.infinite.red/npm-vs-yarn-cheat-sheet-8755b092e5cc)_ | ||
|
||
* Everything works on iOS/Android | ||
* AVA Tests pass in the root folder (`npm test` or `yarn test`) | ||
* Integration tests pass (`cd packages/ignite-integration && npm run integration && cd -`) | ||
* AVA Tests pass in the root folder (`yarn test`) | ||
* Integration tests pass (`yarn run integration`) | ||
* New tests are included for any new functionality | ||
* Code is compliant with StandardJS (`npm run lint` or `yarn lint`) | ||
* Code is compliant with StandardJS (`yarn lint`) | ||
* Branch has already been [synced with the upstream repo](https://help.github.com/articles/syncing-a-fork/) and any merge-conflicts have been resolved. | ||
|
||
## Requirements | ||
|
@@ -23,10 +25,9 @@ Before submitting a pull request, you will want to make sure that your branch me | |
|
||
1. Fork and then clone the repo (`git clone [email protected]:<YOURGITHUBUSER>/ignite.git`) | ||
2. CD into the directory (`cd ignite`) | ||
3. Uninstall npm version (`npm u -g ignite-cli && npm u -g react-native-ignite`) | ||
4. Pull all package dependencies (`npm i && npm run bootstrap`) | ||
5. Link the local binary (`cd packages/ignite-cli && npm link && cd -`) | ||
6. Set up your local plugin path (`export IGNITE_PLUGIN_PATH=$PWD/packages`) | ||
3. Uninstall npm version (`yarn global remove ignite-cli && yarn global remove react-native-ignite`) | ||
4. Pull all package dependencies (`yarn`) | ||
5. Link the local binary (`yarn link`) | ||
|
||
Test it out: | ||
|
||
|
@@ -39,15 +40,15 @@ $ ignite new UberForHeadLice | |
... | ||
``` | ||
|
||
Now you're ready to check out a new branch and get hacking on Ignite! | ||
Now you're ready to check out a new branch and get hacking on Ignite CLI! | ||
|
||
## Source Code | ||
|
||
To get familiarized with Ignite's source code, read the [Tour of Ignite's source code](../docs/advanced-guides/tour.md). | ||
To get familiarized with Ignite CLI's source code, read the [Tour of Ignite CLI's source code](../docs/advanced-guides/tour.md). | ||
|
||
## How to Build and Run App | ||
|
||
Note that if you do not already have the React Native command line tools installed, you should run `npm install -g react-native-cli` or `yarn global add react-native-cli`. For additional information and troubleshooting go to the [React Native Getting Started Guide](https://facebook.github.io/react-native/docs/getting-started.html#content). | ||
Note that if you do not already have the React Native command line tools installed, you should run `yarn global add react-native-cli`. For additional information and troubleshooting go to the [React Native Getting Started Guide](https://facebook.github.io/react-native/docs/getting-started.html#content). | ||
|
||
``` | ||
$ cd ~/your/apps/directory | ||
|
@@ -66,23 +67,18 @@ We use [AVA](https://github.com/avajs/ava) for testing. | |
|
||
To run tests from the ignite-base folder: | ||
``` | ||
$ npm test | ||
or | ||
$ yarn test | ||
``` | ||
|
||
Or to run it in [intelligent watch mode](https://github.com/avajs/ava/blob/master/docs/recipes/watch-mode.md): | ||
``` | ||
$ npm test -- --watch | ||
or | ||
$ yarn test -- --watch | ||
``` | ||
|
||
You'll also want to run the integration tests before submitting a pull request: | ||
|
||
``` | ||
$ cd packages/ignite-cli | ||
$ npm run integration | ||
$ yarn run integration | ||
``` | ||
|
||
## :no_entry_sign: Standard Compliant | ||
|
@@ -93,8 +89,6 @@ This project adheres to Standard. Our CI enforces this, so we suggest you enabl | |
|
||
**To Run Lint** from ignite-base: | ||
``` | ||
$ npm run lint | ||
or | ||
$ yarn lint | ||
``` | ||
|
||
|
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
|
@@ -7,24 +7,24 @@ | |
<a href="https://www.codacy.com/app/gantman/ignite?utm_source=github.com&utm_medium=referral&utm_content=infinitered/ignite&utm_campaign=Badge_Grade" target="_blank"><img src="https://api.codacy.com/project/badge/Grade/1c6e04abe7224bdc88095129b5eb43fb"/></a> | ||
<img src=https://img.shields.io/badge/code%20style-standard-brightgreen.svg?style%3Dflat alt='js-standard-style'/> | ||
|
||
### Ignite | ||
### Ignite CLI | ||
|
||
<p align="center"> | ||
<a href="https://infinite.red/ignite"><img src="https://cloud.githubusercontent.com/assets/1479215/23348302/941b2d54-fc5d-11e6-9042-62501fa90b05.png" alt="Ignite 2 screenshot" width="300px"></a> | ||
<a href="https://infinite.red/ignite"><img src="https://cloud.githubusercontent.com/assets/1479215/23348302/941b2d54-fc5d-11e6-9042-62501fa90b05.png" alt="Ignite CLI screenshot" width="300px"></a> | ||
</p> | ||
|
||
<p align="center"> | ||
:fire: The hottest CLI for React Native, boilerplates, plugins, generators, and more. :fire: | ||
<br/> | ||
</p> | ||
|
||
### Ignite 2 is here! | ||
### Ignite CLI is here! | ||
|
||
After months of work and sweat and tears, Ignite 2 (beta) has landed! We're incredibly proud of where Ignite 2 is and where it's headed. | ||
After months of work and sweat and tears, Ignite CLI has landed! We're incredibly proud of where Ignite CLI is and where it's headed. | ||
|
||
Cliff notes version of the difference between Ignite 1 and 2: | ||
Cliff notes version of the difference between Ignite 1 and Ignite CLI: | ||
|
||
Ignite 1 was a (very nice!) [React Native](http://facebook.github.io/react-native/docs/getting-started.html) boilerplate. Ignite 2 is a CLI and generator for React Native with boilerplates, plugins, and more. Where before you had one choice -- [Infinite Red](https://infinite.red)'s boilerplate -- now you can choose from many boilerplates and also add standalone plugins as you need them. It's much more modular and extensible than Ignite 1. | ||
Ignite 1 was a (very nice!) [React Native](http://facebook.github.io/react-native/docs/getting-started.html) boilerplate. Ignite CLI is a generator for React Native with boilerplates, plugins, and more. Where before you had one choice -- [Infinite Red](https://infinite.red)'s boilerplate -- now you can choose from many boilerplates and also add standalone plugins as you need them. It's much more modular and extensible than Ignite 1. | ||
|
||
If you really liked Ignite 1 as it was, then not much has changed! You just run `ignite new MyApp --max` and everything feels pretty normal from there. | ||
|
||
|
@@ -45,24 +45,15 @@ $ ignite remove i18n | |
$ ignite i love you | ||
``` | ||
|
||
### Why Ignite? | ||
### Why Ignite CLI? | ||
|
||
* Easily spin up a new React Native app with best practices built-in | ||
* No runtime! This is a developer tool only, not a library you have to depend on | ||
* An ever-expanding list of boilerplates and plugins | ||
* An ever-expanding list of [boilerplates](./BOILERPLATES.md) and [plugins](./PLUGINS.md) | ||
* Powerful but well-defined behavior | ||
* Battle tested and used every day by the developers at Infinite Red | ||
|
||
And you also get (by default) all of the sweet, sweet goodness of our default boilerplate: | ||
|
||
* Works with iOS and Android out of the box | ||
* Useful generators, including components, screens, styles, and more | ||
* API-ready -- hook it up and start talking to your server | ||
* Standard-js compliant code | ||
* Redux and redux-sagas state management | ||
* Well-documented code | ||
* Gorgeous Ava tests | ||
* and much, much more... [go check out the readme](https://github.com/infinitered/ignite-ir-boilerplate-2016) (WIP during alpha) | ||
And you also get (by default) all of the sweet, sweet goodness of [our default boilerplate](https://github.com/infinitered/ignite-ir-boilerplate-2016), or choose [one of many others](./BOILERPLATES.md). | ||
|
||
## :arrow_down: Install | ||
|
||
|
@@ -93,7 +84,7 @@ $ ignite new MyNewAppName | |
``` | ||
## :clipboard: Documentation :clipboard: | ||
|
||
Want to dive into the Ignite 2 documentation? [Go here](./docs/README.md) | ||
Want to dive into the Ignite CLI documentation? [Go here](./docs/README.md) | ||
Looking for React Native's documentation? [Go here](http://facebook.github.io/react-native/docs/getting-started.html) | ||
|
||
## :electric_plug: Plugins :electric_plug: | ||
|
@@ -110,16 +101,16 @@ If you run into problems, first search the issues in this repository. If you don | |
|
||
## :telescope: Where to Go From Here :telescope: | ||
|
||
#### [Contribute to Ignite](https://github.com/infinitered/ignite/blob/master/.github/CONTRIBUTING.md) - Getting up and running for your first pull request | ||
#### [Take a tour of Ignite source code](https://github.com/infinitered/ignite/blob/master/docs/advanced-guides/tour.md) | ||
#### [Contribute to Ignite CLI](https://github.com/infinitered/ignite/blob/master/.github/CONTRIBUTING.md) - Getting up and running for your first pull request | ||
#### [Take a tour of Ignite CLI source code](https://github.com/infinitered/ignite/blob/master/docs/advanced-guides/tour.md) | ||
#### [Chat with us on the IR Community](http://community.infinite.red) - Infinite Red devs standing by | ||
#### [Who are We?](https://infinite.red) - Learn More About Infinite Red | ||
#### [Project Web Page](https://infinite.red/ignite/) - Ignite on Infinite Red | ||
|
||
## :heart: Special Thanks :heart: | ||
Thank you to the numerous [contributors of Ignite](https://github.com/infinitered/ignite/graphs/contributors). Our awe and appreciation for the friendliness of Open Source is the fuel for all [Infinite Red](https://infinite.red/) projects like Ignite. | ||
Thank you to the numerous [contributors of Ignite CLI](https://github.com/infinitered/ignite/graphs/contributors). Our awe and appreciation for the friendliness of Open Source is the fuel for all [Infinite Red](https://infinite.red/) projects like Ignite CLI. | ||
|
||
## Premium Support | ||
|
||
[Ignite](https://infinite.red/ignite), as open source projects, is free to use and always will be. [Infinite Red](https://infinite.red/) offers premium Ignite support and general mobile app design/development services. Email us at [[email protected]](mailto:[email protected]) to get in touch with us for more details. | ||
[Ignite CLI](https://infinite.red/ignite), as open source projects, is free to use and always will be. [Infinite Red](https://infinite.red/) offers premium Ignite CLI and boilerplate support and general mobile app design/development services. Email us at [[email protected]](mailto:[email protected]) to get in touch with us for more details. | ||
|
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
This file was deleted.
Oops, something went wrong.
File renamed without changes.
Oops, something went wrong.