|
1 |
| -# ReactPrimer |
| 1 | +<h1><center>ReactPrimer </center></h1> |
| 2 | +<p align="center"> |
| 3 | + <img src="/assets/icons/png/128x128.png"> |
| 4 | +</p> |
2 | 5 |
|
3 |
| -One Paragraph of project description goes here |
| 6 | +<p align="center">React Primer is component prototyping tool that generates fully connected class component code.</p> |
| 7 | +<p align="center"> |
| 8 | +<img src="/assets/demo/demo_15mb.gif"/> |
| 9 | +</p> |
4 | 10 |
|
5 |
| -## Getting Started |
| 11 | +## Setup |
6 | 12 |
|
7 |
| -These instructions will get you a copy of the project up and running on your local machine for development and testing purposes. See deployment for notes on how to deploy the project on a live system. |
| 13 | +###### MacOS |
8 | 14 |
|
9 |
| -### Prerequisites |
| 15 | +1. [Download](https://github.com/ReactPrimer/ReactPrimer/releases/download/0.0.0.0.2/ReactPrimer.dmg) the latest release .dmg file. |
| 16 | +2. Open the installer. |
| 17 | +3. Move React Primer to you local application folder. |
10 | 18 |
|
11 |
| -What things you need to install the software and how to install them |
| 19 | +###### Linux |
| 20 | +1. [Download](https://github.com/ReactPrimer/ReactPrimer/releases/download/0.0.0.0.2/React-Primer_1.0.0_amd64.deb) the latest .deb file |
| 21 | +2. Unpackage the .deb file |
| 22 | +3. Find the executable in usr/lib/React-Primer |
12 | 23 |
|
13 |
| -``` |
14 |
| -Give examples |
15 |
| -``` |
| 24 | +###### Windows |
| 25 | +*Coming Soon* |
16 | 26 |
|
17 |
| -### Installing |
| 27 | +## Usage |
18 | 28 |
|
19 |
| -A step by step series of examples that tell you have to get a development env running |
| 29 | +* Name individual components, assign parent-child relationships, and add components to the project tree. |
20 | 30 |
|
21 |
| -Say what the step will be |
| 31 | +* Drag and drop individual components to restructure the hierarchy tree view. |
22 | 32 |
|
23 |
| -``` |
24 |
| -Give the example |
25 |
| -``` |
| 33 | +* Export project to generate a folder of fully connected component classes. |
26 | 34 |
|
27 |
| -And repeat |
| 35 | +* Save generated components locally to a new or existing project. |
28 | 36 |
|
29 |
| -``` |
30 |
| -until finished |
31 |
| -``` |
| 37 | +## Forking Your Own Version |
| 38 | +**If you'd like to build your own version of React Primer:** |
32 | 39 |
|
33 |
| -End with an example of getting some data out of the system or using it for a little demo |
| 40 | +1. Clone the repo and `npm install` dependancies. |
34 | 41 |
|
35 |
| -## Running the tests |
| 42 | +2. Open one terminal and `npm run dev` to generate the webpack build. |
36 | 43 |
|
37 |
| -Explain how to run the automated tests for this system |
| 44 | +3. Open another terminal and `npm start` to start Electron. |
38 | 45 |
|
39 |
| -### Break down into end to end tests |
| 46 | +4. Uncomment line 23 `require('electron-reload')(__dirname);` for hot reloading (Optional). |
40 | 47 |
|
41 |
| -Explain what these tests test and why |
| 48 | +3. Enable Devloper Tools (Optional). |
42 | 49 |
|
43 |
| -``` |
44 |
| -Give an example |
45 |
| -``` |
| 50 | + *Chrome Developer Tool* |
46 | 51 |
|
47 |
| -### And coding style tests |
| 52 | + a. Uncomment line 45 `mainWindow.webContents.openDevTools()` |
48 | 53 |
|
49 |
| -Explain what these tests test and why |
| 54 | + *React Developer Tool* |
| 55 | + |
| 56 | + a. Uncomment line 78 `const configValues = require('./config');` |
| 57 | + |
| 58 | + b. Uncomment line 79 `BrowserWindow.addDevToolsExtension(configValues.absolutePath);` |
| 59 | + |
| 60 | + c. Create `./config` in root directory: |
50 | 61 |
|
51 | 62 | ```
|
52 |
| -Give an example |
| 63 | +{ |
| 64 | + "absolutePath": "/Users/*User*/Library/Application Support/Google/Chrome/Default/Extensions/fmkadmapgofadopljbjfkapdkoienihi/2.5.2_0" |
| 65 | +} |
53 | 66 | ```
|
54 | 67 |
|
55 |
| -## Deployment |
| 68 | +## Why |
| 69 | + |
| 70 | +React Primer provides a visual representation of your project during the preliminary stages of development, before you write a single line of code. |
56 | 71 |
|
57 |
| -Add additional notes about how to deploy this on a live system |
| 72 | +This simple to use application saves time by generating component files that automatically require and render their child components based on the prototyped hierarchy. |
58 | 73 |
|
59 |
| -## Built With |
| 74 | +React Primer’s component tree GUI makes it easy to test, edit, and re-export your component tree as many times as needed. |
60 | 75 |
|
61 |
| -* [Dropwizard](http://www.dropwizard.io/1.0.2/docs/) - The web framework used |
62 |
| -* [Maven](https://maven.apache.org/) - Dependency Management |
63 |
| -* [ROME](https://rometools.github.io/rome/) - Used to generate RSS Feeds |
64 | 76 |
|
65 | 77 | ## Contributing
|
66 | 78 |
|
67 |
| -Please read [CONTRIBUTING.md](https://gist.github.com/PurpleBooth/b24679402957c63ec426) for details on our code of conduct, and the process for submitting pull requests to us. |
68 | 79 |
|
69 |
| -## Versioning |
| 80 | +Please submit issues/pull requests if you have feedback or message the React Primer team to be added as a contributor: [email protected] |
70 | 81 |
|
71 | 82 |
|
72 | 83 | ## Authors
|
73 | 84 |
|
74 |
| -* *Kat* - https://github.com/ksampias |
75 |
| -* *Vince* - https://github.com/vincevuong |
76 |
| -* *Ken* - https://github.com/kenhughlee |
| 85 | +Ken Lee (https://github.com/kenhughlee) |
77 | 86 |
|
78 |
| -## License |
| 87 | +Kat Sampias (https://github.com/ksampias) |
79 | 88 |
|
80 |
| -This project is licensed under the MIT License - see the [LICENSE.md](LICENSE.md) file for details |
| 89 | +Vince Vuong (https://github.com/vincevuong) |
81 | 90 |
|
82 |
| -## Acknowledgments |
| 91 | +## License |
83 | 92 |
|
84 |
| -* Hat tip to anyone who's code was used |
85 |
| -* Inspiration |
86 |
| -* etc |
| 93 | +This project is licensed under the MIT License - see the [LICENSE.md](LICENSE.md) file for details |
0 commit comments