Skip to content

Commit be164da

Browse files
authored
Update README.md
1 parent 35df5ed commit be164da

File tree

1 file changed

+12
-131
lines changed

1 file changed

+12
-131
lines changed

README.md

+12-131
Original file line numberDiff line numberDiff line change
@@ -1,137 +1,18 @@
11
# EquationSolver
22

3-
[![Build Status](https://semaphoreci.com/api/v1/ir/ignite-ir-boilerplate-bowser/branches/master/badge.svg)](https://semaphoreci.com/ir/ignite-ir-boilerplate-bowser)
43

4+
# Installation
5+
1. git clone https://github.com/ebouJ/Equation-Solver
6+
2. cd Equation-Solver
7+
3. yarn install or npm install
8+
4. react-native run-ios
59

610

7-
## The latest and greatest boilerplate for Infinite Red opinions
11+
## Appstore URL
12+
[Equation Solver](https://itunes.apple.com/us/app/equation-solver/id1420956198?mt=8)
13+
## Screenshots
14+
![1](https://user-images.githubusercontent.com/22877561/48787265-753dfd80-ecb6-11e8-80d7-4ecd26da8847.jpg)
15+
![2](https://user-images.githubusercontent.com/22877561/48787759-6dcb2400-ecb7-11e8-910f-58a6fa093522.jpg)
16+
![3](https://user-images.githubusercontent.com/22877561/48787763-6f94e780-ecb7-11e8-886c-2119181e0897.jpg)
17+
![4](https://user-images.githubusercontent.com/22877561/48787767-70c61480-ecb7-11e8-9f28-c49393fe4c38.jpg)
818

9-
This is the boilerplate that [Infinite Red](https://infinite.red) uses as a way to test bleeding-edge changes to our React Native stack.
10-
11-
Currently includes:
12-
13-
* React Native
14-
* React Navigation
15-
* MobX State Tree
16-
* TypeScript
17-
* And more!
18-
19-
## Quick Start
20-
21-
The Ignite Bowser boilerplate project's structure will look similar to this:
22-
23-
```
24-
ignite-project
25-
├── src
26-
│   ├── app
27-
│   ├── i18n
28-
│   ├── lib
29-
│   ├── models
30-
│   ├── navigation
31-
│   ├── services
32-
│   ├── theme
33-
│   ├── views
34-
├── storybook
35-
│   ├── views
36-
│   ├── index.ts
37-
│   ├── storybook-registry.ts
38-
│   ├── storybook.ts
39-
├── test
40-
│   ├── __snapshots__
41-
│   ├── storyshots.test.ts.snap
42-
│   ├── mock-i18n.ts
43-
│   ├── mock-reactotron.ts
44-
│   ├── setup.ts
45-
│   ├── storyshots.test.ts
46-
├── README.md
47-
├── android
48-
│   ├── app
49-
│   ├── build.gradle
50-
│   ├── gradle
51-
│   ├── gradle.properties
52-
│   ├── gradlew
53-
│   ├── gradlew.bat
54-
│   ├── keystores
55-
│   └── settings.gradle
56-
├── ignite
57-
│   ├── ignite.json
58-
│   └── plugins
59-
├── index.js
60-
├── ios
61-
│   ├── IgniteProject
62-
│   ├── IgniteProject-tvOS
63-
│   ├── IgniteProject-tvOSTests
64-
│   ├── IgniteProject.xcodeproj
65-
│   └── IgniteProjectTests
66-
└── package.json
67-
```
68-
69-
The directory structure uses a ["feature first, function second"](https://alligator.io/react/index-js-public-interfaces/) approach to organization. Files are grouped by the feature they are supporting rather than the type of file.
70-
71-
For example: A custom `Button` component would have the main component file, and test, and any assets or helper files all grouped together in one folder.
72-
73-
This is a departure from the previous boilerplate, which grouped files by type (components together, styles together, tests together, images together, etc.). One feature of this new approach is the use of index files which export specific functions from files in the directory to create a public interface for each "thing", or "feature. You'll see that pattern quite a bit in this boilerplate.
74-
75-
76-
## ./src directory
77-
78-
Included in an Ignite boilerplate project is the src directory. This is a directory you would normally have to create when using vanilla React Native.
79-
80-
The inside of the src directory looks similar to the following:
81-
82-
```
83-
src
84-
├── app
85-
│── i18n
86-
├── lib
87-
├── models
88-
├── navigation
89-
├── services
90-
├── theme
91-
├── views
92-
```
93-
94-
**app**
95-
This is where a lot of your app's initialization takes place. Here you'll find:
96-
* root-component.tsx - This is the root component of your app that will render your navigators and other views.
97-
98-
**i18n**
99-
This is where your translations will live if you are using `react-native-i18n`.
100-
101-
**lib**
102-
This is a great place to put miscellaneous helpers and utilities. Things like date helpers, formatters, etc. are often found here. However, it should only be used for things that are truely shared across your application. If a helper or utility is only used by a specific component or model, consider co-locating your helper with that component or model.
103-
104-
**models**
105-
This is where your app's models will live. Each model has a directory which will contain the `mobx-state-tree` model file, test file, and any other supporting files like actions, types, etc.
106-
107-
**navigation**
108-
This is where your `react-navigation` navigators will live.
109-
110-
**services**
111-
Any services that interface with the outside world will live here (think REST APIs, Push Notifications, etc.).
112-
113-
**theme**
114-
Here lives the theme for your application, including spacing, colors, and typography.
115-
116-
**views**
117-
This is where all of your components will live. Both dumb components and screen components will be located here. Each component will have a directory containing the `.tsx` file, along with a story file, and optionally `.presets`, and `.props` files for larger components.
118-
119-
You may choose to futher break down this directory by organizing your components into "domains", which represent cohesive areas of your application. For example, a "user" domain could hold all components and screens related to managing a user.
120-
121-
**storybook**
122-
This is where your stories will be registered and where the Storybook configs will live
123-
124-
**test**
125-
This directory will hold your Jest configs and mocks, as well as your [storyshots](https://github.com/storybooks/storybook/tree/master/addons/storyshots) test file. This is a file that contains the snapshots of all your component storybooks.
126-
127-
**ignite**
128-
The `ignite` directory stores all things Ignite, including CLI and boilerplate items. Here you will find generators, plugins and examples to help you get started with React Native.
129-
130-
## Previous Boilerplates
131-
132-
* [2017 aka Andross](https://github.com/infinitered/ignite-ir-boilerplate-andross)
133-
* [2016 aka Ignite 1.0](https://github.com/infinitered/ignite-ir-boilerplate-2016)
134-
135-
## Premium Support
136-
137-
[Ignite CLI](https://infinite.red/ignite) and [Ignite IR Boilerplate](https://github.com/infinitered/ignite-ir-boilerplate-bowser), as open source projects, are free to use and always will be. [Infinite Red](https://infinite.red/) offers premium Ignite CLI 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.

0 commit comments

Comments
 (0)