Skip to content

Commit

Permalink
Moves ignite-cli into main directory, removes lerna, renames to Ignit…
Browse files Browse the repository at this point in the history
…e CLI everywhere
  • Loading branch information
jamonholmgren committed May 2, 2017
1 parent e884af6 commit 769f2a7
Show file tree
Hide file tree
Showing 110 changed files with 196 additions and 571 deletions.
34 changes: 14 additions & 20 deletions .github/CONTRIBUTING.md
Original file line number Diff line number Diff line change
@@ -1,17 +1,19 @@

# Contributing to Ignite
# Contributing to Ignite CLI

[![js-standard-style](https://img.shields.io/badge/code%20style-standard-brightgreen.svg?style=flat)](http://standardjs.com/) [![Build Status](https://semaphoreci.com/api/v1/ir/ignite/branches/master/shields_badge.svg)](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
Expand All @@ -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:

Expand All @@ -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
Expand All @@ -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
Expand All @@ -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
```

Expand Down
4 changes: 2 additions & 2 deletions .github/ISSUE_TEMPLATE.md
Original file line number Diff line number Diff line change
@@ -1,8 +1,8 @@
### Hey there! Ignite seems to be having a problem, eh?
### Hey there! Ignite CLI seems to be having a problem, eh?

Welllllll, it just might be. First, search the issues to make sure it's not already
here, and if not head over to http://community.infinite.red to
get some help. If you've identified that it's really an Ignite issue, then:
get some help. If you've identified that it's really an Ignite CLI issue, then:

- Explain what's going on and preferably how to replicate the issue (bonus points for a repro app)
- Run `ignite doctor` and paste the result below, including the lines with 3 backticks
Expand Down
3 changes: 2 additions & 1 deletion .gitignore
Original file line number Diff line number Diff line change
Expand Up @@ -6,11 +6,12 @@ npm-debug.log*
coverage
.nyc_output
yarn.lock
lerna-debug.log
node_modules
.vscode/*
!.vscode/settings.json
!.vscode/tasks.json
!.vscode/launch.json
!.vscode/extensions.json
testgrounds
generated
tests/out
37 changes: 14 additions & 23 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,24 +7,24 @@
<a href="https://www.codacy.com/app/gantman/ignite?utm_source=github.com&amp;utm_medium=referral&amp;utm_content=infinitered/ignite&amp;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.

Expand All @@ -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

Expand Down Expand Up @@ -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:
Expand All @@ -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 removed _art/ignite_logo.png
Binary file not shown.
Binary file removed _art/in_use.jpg
Binary file not shown.
Binary file removed _art/install.gif
Binary file not shown.
Binary file removed _art/screens.gif
Binary file not shown.
126 changes: 0 additions & 126 deletions bin/fireDrill.sh

This file was deleted.

File renamed without changes.
Loading

0 comments on commit 769f2a7

Please sign in to comment.