Skip to content

Commit 78380ae

Browse files
authored
Merge pull request #1 from tonyito/staging
Updated Readme
2 parents 286a83e + 8f52efb commit 78380ae

File tree

1 file changed

+26
-5
lines changed

1 file changed

+26
-5
lines changed

README.md

Lines changed: 26 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,4 @@
1+
12
<p align="center">
23
<img width="50" src="https://github.com/team-reactype/ReacType/blob/master/src/public/icons/png/256x256.png?raw=true">
34
<h1 align="center">ReacType </h1>
@@ -6,14 +7,14 @@
67
[![PRs Welcome](https://img.shields.io/badge/PRs-welcome-brightgreen.svg)](https://github.com/team-reactype/ReacType/pulls)
78
![License: MIT](https://img.shields.io/badge/License-MIT-yellow.svg)
89

9-
**ReacType** is a visual prototyping tool for developers employing **React** component architecture alongside the comprehensive type checking of **TypeScript**.
10+
**ReacType** is a visual prototyping tool for developers employing **React** component architecture alongside the comprehensive type checking of **TypeScript**.
1011
In other words, **you can draw prototypes and export React / Typescript code!**
1112

1213
**ReacType** allows the user to _visualize_ their application architecture dynamically, employing a _canvas display_, an _application tree_, and a _real-time component code preview_. The user can create components and load _instances_ of these components, as well as nested HTML elements, onto the canvas. This architecture can then be _exported_ as TypeScript application files to be used as a starter template for any repository.
1314

1415
Download for [MacOS](https://github.com/team-reactype/ReacType/releases/tag/Mac.Version.1.0), [Windows](https://github.com/team-reactype/ReacType/releases/tag/Win.Version.1.0), [Linux](https://github.com/team-reactype/ReacType/releases/tag/Linux.Version.1.0).
1516

16-
- **Mac users**: for now you might need to go to your security settings to allow the app run on your system as we do not have an Apple license yet.
17+
* **Mac users**: for now you might need to go to your security settings to allow the app run on your system as we do not have an Apple license yet.
1718

1819
![Image of ReacType Application](https://i.imgur.com/0wV7R1P.jpg)
1920

@@ -46,6 +47,7 @@ Download for [MacOS](https://github.com/team-reactype/ReacType/releases/tag/Mac.
4647
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.
4748

4849
#### Contributors
50+
4951
[Adam Singer](https://linkedin.com/in/adsing) [@spincycle01](https://github.com/spincycle01)
5052

5153
[Charles Finocchiaro](https://www.linkedin.com/in/charles-finocchiaro-62440040/) [@null267](https://github.com/null267)
@@ -66,17 +68,36 @@ Download for [MacOS](https://github.com/team-reactype/ReacType/releases/tag/Mac.
6668

6769
[Tolga Mizrakci](https://linkedin.com/in/tolga-mizrakci) [@tolgamizrakci](https://github.com/tolgamizrakci)
6870

69-
7071
## To Run Your Own Version
7172

7273
- **Fork** and **Clone** Repository.
7374
- Open project directory
7475
- Install dependencies
7576

76-
## License
77+
- npm works in place of yarn as well.
7778

78-
This project is licensed under the MIT License - see the [LICENSE.md](https://github.com/team-reactype/ReacType/blob/development/LICENSE.md) file for details.
79+
```bash
80+
yarn install
81+
```
7982

83+
- Run application
84+
85+
```bash
86+
yarn start
8087
```
8188

89+
- For development experience, in one terminal...
90+
91+
```bash
92+
yarn run dev
8293
```
94+
95+
- and on another terminal
96+
97+
```bash
98+
yarn run electron
99+
```
100+
101+
## License
102+
103+
This project is licensed under the MIT License - see the [LICENSE.md](https://github.com/team-reactype/ReacType/blob/development/LICENSE.md) file for details.

0 commit comments

Comments
 (0)