|
1 | | -# React-Proto [](https://travis-ci.com/CS-Eevee/react-proto) [](https://opensource.org/licenses/MIT) |
| 1 | +# React-Proto [](https://travis-ci.com/React-Proto/react-proto) [](https://opensource.org/licenses/MIT) |
2 | 2 |
|
3 | 3 | <img src="https://github.com/React-Proto/react-proto/blob/master/icons/png/64x64.png"/> |
4 | 4 |
|
5 | | -[React-Proto](https://react-proto.github.io/react-proto/) is a React application prototyping tool. |
| 5 | +[React-Proto](https://react-proto.github.io/react-proto/) is a React application prototyping tool for developers and designers. |
6 | 6 |
|
7 | | -React-Proto allows developers to visualize/setup your application architecture upfront and recreate this architecture as application files either into a previous project or a new create-react-app project or a starter template from any repository. |
| 7 | +React-Proto allows the user to visualize/setup their application architecture upfront and eject this architecture as application files either into a previous project or a new create-react-app project or a starter template from any repository. |
| 8 | + |
| 9 | +Download for [MacOS](https://github.com/React-Proto/react-proto/releases/download/v1.0.0/React-Proto-1.0.0.dmg), [Windows](https://github.com/React-Proto/react-proto/releases/download/v1.0.0/React-Proto.Web.Setup.1.0.0.exe), [Linux](https://github.com/React-Proto/react-proto/releases/download/v1.0.0/react-proto_1.0.0_amd64.deb). |
8 | 10 |
|
9 | | -React-Proto works on macOS, & Windows |
10 | 11 | If you find any issues, [file issue](https://github.com/React-Proto/react-proto/issues) |
11 | 12 |
|
12 | 13 | ## How To Use |
@@ -48,32 +49,49 @@ If you find any issues, [file issue](https://github.com/React-Proto/react-proto/ |
48 | 49 |
|
49 | 50 | ## Running Your Own Version |
50 | 51 |
|
51 | | -**Fork** and **Clone** Repository. |
| 52 | +- **Fork** and **Clone** Repository. |
52 | 53 |
|
| 54 | +- Open project directory |
53 | 55 |
|
54 | 56 | ``` bash |
55 | | -# Open project directory |
56 | 57 | cd react-proto |
| 58 | +``` |
| 59 | + |
| 60 | +- Install dependencies |
57 | 61 |
|
58 | | -# Install dependencies |
| 62 | +``` bash |
59 | 63 | yarn install |
| 64 | +``` |
60 | 65 |
|
61 | | -# Run application |
| 66 | +- Run application |
| 67 | + |
| 68 | +``` bash |
62 | 69 | yarn start |
| 70 | +``` |
63 | 71 |
|
64 | | -# For development environment... |
65 | | -yarn run dev |
| 72 | +- For development experience... |
66 | 73 |
|
67 | | -# on another terminal |
68 | | -yarn run electron |
| 74 | +``` bash |
| 75 | +yarn dev |
| 76 | +``` |
| 77 | + |
| 78 | +- and on another terminal |
| 79 | + |
| 80 | +``` bash |
| 81 | +yarn electron |
| 82 | +``` |
| 83 | + |
| 84 | +## Linting |
69 | 85 |
|
70 | | -# Run Linter |
71 | | -yarn run linter |
| 86 | +``` bash |
| 87 | +yarn linter |
72 | 88 | ``` |
73 | 89 |
|
74 | 90 | ## Testing |
75 | 91 |
|
76 | | -Run ```npm test``` or ```yarn test``` to run test suite. |
| 92 | +```bash |
| 93 | +yarn test |
| 94 | +``` |
77 | 95 |
|
78 | 96 | ## Built With |
79 | 97 |
|
|
0 commit comments