Skip to content

Commit cece170

Browse files
authored
Merge pull request #47 from CS-Eevee/read_me
Added how to section to read me
2 parents 0d85a33 + 0538928 commit cece170

File tree

1 file changed

+30
-0
lines changed

1 file changed

+30
-0
lines changed

README.md

Lines changed: 30 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -7,6 +7,36 @@ It allows you to visualize/setup your application architecture upfront and recre
77
React-Proto works on macOS, Windows, Linux.
88
If you find any issues, [file issue](https://github.com/CS-Eevee/react-proto/issues)
99

10+
## How To Use
11+
12+
- To start a new project, either import an image file for the application you want to build or start with a blank stage.
13+
14+
- Using the input at the top of the left column, input the name of the component you would like to create, then drag it into place and resize accordingly.
15+
16+
<img src="https://github.com/CS-Eevee/react-proto/blob/master/assets/dragging.gif"/>
17+
18+
- While building, you can use the icons in the toolbar to zomm in and zoom out, toggle the draggability of the stage, update or remove the image, collapse the left container, and eventually export your files.
19+
20+
- For each component you have a series of options: You can define whether your component will have state, the color of the component on the screen, and the ability to apply a parent component.
21+
22+
- If you place a container around other components and can no longer access them, you can use the layer buttons in the corresponding dropdown menu to decrease the z-index. Alternatively, you can increase the z-index of the desired components.
23+
24+
- After you have successfully structured your components, you can use the dropdown menu to apply parent components and visualize the hierarchy of your application structure.
25+
26+
<img src="https://github.com/CS-Eevee/react-proto/blob/master/assets/hierarchy.gif"/>
27+
28+
- In the right container, the props tab allows you to define props in key value pairs, as well as the necessary prop type.
29+
30+
- Once you are finished, you can use the export button in the toolbar to choose from three options of how to export your files:
31+
1. Import your files into an existing project. Just choose the path where you would like to create your components folder.
32+
2. Use create-react-app to start a new project (the project will be under the "proto_app").
33+
3. Clone your favorite Github repo to start a project with your favorite starter files.
34+
35+
<img src="https://github.com/CS-Eevee/react-proto/blob/master/assets/export.gif"/>
36+
37+
38+
- Lastly, start building!
39+
1040
## Authors
1141

1242
[Blessing E Ebowe](https://www.linkedin.com/in/blessingebowe/) [@refinedblessing](https://github.com/refinedblessing)

0 commit comments

Comments
 (0)