|
1 | 1 | # ReacType |
2 | | -Prototyping Tool for React/Typescript Applications |
| 2 | + |
| 3 | +**ReacType** is a prototyping tool for developers employing **React** component architecture while utilizing the comprehensive type checking of **TypeScript**. |
| 4 | + |
| 5 | +**ReacType** allows the user to _visualize_ their application architecture dynamically, employing a _canvas display_, an _application tree_, and a _component code preview_. The user can create components and load _instances_ of these components, as well as nested HTML elements, onto the canvas. These visual representations quickly reveal parent-child relationships between components and the embedded instances, with component views that can be toggled between and draggable representations that resized on the canvas itself. This architecture can then be _exported_ as TypeScript application files to be used as a starter template for any repository. |
| 6 | + |
| 7 | +Download for [MacOS](), [Windows](), [Linux](). |
| 8 | + |
| 9 | +### How to use |
| 10 | + |
| 11 | +- Open the application to start a new project. It will open in the root App component, with its name listed in the left panel and the component represented by the white box on the canvas. |
| 12 | +- To add a new component, type its name in the upper right panel, in the field '**Add class component**', and press the plus button. |
| 13 | +- To render a component **_instance_** to the screen, first select the component, or _parent_, that the instance will be rendered within. This selected component will be represented in a new canvas view, with its own white box. Then press the plus button next to the component name. An instance, or _child_, representation will appear on the canvas. |
| 14 | +- To add draggable HTML elements, select the image icons on the lower left panel. |
| 15 | +- The bottom panel allows the user to toggle between 4 different views: a tree diagram of the application, a preview of the code, a form to enter component props, and a form to add HTML attributes. |
| 16 | +- **_Props_** can be added to each component within its tab on bottom panel. Enter in a _key-value pair_, select its data _type_ and press the bottom 'ADD PROP'. |
| 17 | +- **_HTML Element Attributes_** of class name and ID can be added to each HTML element after an HTML element has been rendered to the canvas. |
| 18 | +- To **_delete_** a _child_ or instance from the canvas, select the desired instance and either press the _delete_ key or click the 'DELETE CHILD' button. |
| 19 | +- To **_delete_** a _component_, click the 'DELETE' button of the desired component in the left panel. |
| 20 | +- To _start over_, select the blue 'CLEAR WORKSPACE' button in the left panel. This will **clear the entire application**. |
| 21 | + |
| 22 | +### To Export Files |
| 23 | + |
| 24 | +- Once finished setting up the application template, press the green 'EXPORT PROJECT' button at the bottom of the left panel and choose between two options to export your files: |
| 25 | + 1. Export the component files into a src folder. This option will allow a developer to add these files to an existing project. |
| 26 | + 1. Export a new project with TypeScript config files and the component files. This option will allow a developer to immediately begin a new project. |
| 27 | + |
| 28 | +#### Authors |
| 29 | + |
| 30 | +[Christian Padilla](linkedin.com/in/ChristianEdwardPadilla) [@ChristianEdwardPadilla](https://github.com/ChristianEdwardPadilla) |
| 31 | + |
| 32 | +[Tolga Mizrakci](linkedin.com/in/tolga-mizrakci) [@tolgamizrakci](https://github.com/tolgamizrakci) |
| 33 | + |
| 34 | +[Shlomo Porges](linkedin.com/shlomoporges) [@shlomoporges](https://github.com/ShlomoPorges) |
| 35 | + |
| 36 | +[Adam Singer](linkedin.com/in/adsing) [@spincycle01](https://github.com/spincycle01) |
| 37 | + |
| 38 | +## To Run Your Own Version |
| 39 | + |
| 40 | +- **Fork** and **Clone** Repository. |
| 41 | +- Open project directory |
| 42 | +- Install dependencies |
| 43 | + |
| 44 | +```bash |
| 45 | +yarn install |
| 46 | +``` |
| 47 | + |
| 48 | +- Run application |
| 49 | + |
| 50 | +```bash |
| 51 | +yarn start |
| 52 | +``` |
| 53 | + |
| 54 | +- For development experience, in one terminal... |
| 55 | + |
| 56 | +```bash |
| 57 | +yarn run dev |
| 58 | +``` |
| 59 | + |
| 60 | +- and on another terminal |
| 61 | + |
| 62 | +```bash |
| 63 | +yarn run electron |
| 64 | +``` |
| 65 | + |
| 66 | +### Logo Design |
| 67 | + |
| 68 | +## License |
| 69 | + |
| 70 | +This project is licensed under the MIT License - see the [LICENSE.md]() file for details. |
0 commit comments