Skip to content

Commit dafee34

Browse files
author
john lim
committed
readme was changed
1 parent 2c8b233 commit dafee34

File tree

1 file changed

+15
-8
lines changed

1 file changed

+15
-8
lines changed

README.md

Lines changed: 15 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -3,18 +3,25 @@
33
<h1 align="center">ReacType </h1>
44
</p>
55

6-
**ReacType Server** is the backend complement to the visual React prototyping tool **ReacType**. It is built in **Node.js** with the **Express** framework linked to **MongoDB** to handle user authentication (personal accounts on our own database as well as through Github Oauth), sessions, and user project management. The server itself is officially deployed through Heroku, but you can host your own local environment to communicate with the database with this repo.
6+
[![PRs Welcome](https://img.shields.io/badge/PRs-welcome-brightgreen.svg)](https://github.com/team-reactype/ReacType/pulls)
7+
![License: MIT](https://img.shields.io/badge/License-MIT-yellow.svg)
8+
![Release: 3.0](https://img.shields.io/badge/Release-3.0-orange)
79

8-
**For future development teams**: If you wish to update the server and re-deploy through heroku, you will need to get the credentials from one of the last team members:
10+
**ReacType** is a visual prototyping tool for developers employing **React** component architecture alongside the comprehensive type checking of **TypeScript**.
11+
In other words, **you can draw prototypes and export React / Typescript code!**
912

10-
- [Tyler Sullberg](https://www.linkedin.com/in/tyler-sullberg) [@tsully](https://github.com/tsully)
11-
- [Andrew Cho](https://www.linkedin.com/in/andrewjcho84/) [@andrewjcho84](https://github.com/andrewjcho84)
12-
- [Aaron Bumanglag](https://www.linkedin.com/in/akbuma) [@akbuma](https://github.com/akbuma)
13-
- [Fredo Chen](https://www.linkedin.com/in/fredochen/) [@fredosauce](https://github.com/fredosauce)
13+
**ReacType** allows the user to _visualize_ their application architecture dynamically, employing a _drag-and-drop canvas display_ and a _real-time component code preview_. The user can create components and drag _instances_ of these components, as well as 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.
1414

15-
Redeployment should also be done with only the server subtree and not the entire repo. See this <a href="https://medium.com/@shalandy/deploy-git-subdirectory-to-heroku-ea05e95fce1f">article</a> about deploying just a subdirectory.
15+
**New with version 3.0:**
1616

17-
If `npm` is your package manager, you just need to run the script `npm run dev` and it will start the server on `http://localhost:5000` for your development environment.
17+
- Export code as a [Next.js](https://nextjs.org/) project
18+
- Create nestable components/HTML elements using a drag-and-drop canvas
19+
- Add CSS to any element on the canvas
20+
- Components and HTML canvas elements are rendered in the canvas in the same way they'll be rendered in the exported project
21+
- View dynamically generated Next.js or classic React code as you build your project
22+
- Authenticate with Github or email
23+
- Save data for multiple projects in the cloud
24+
- Critical Electron security gaps resolved
1825

1926
Download for [MacOS](https://github.com/team-reactype/ReacType/releases), [Windows](https://github.com/team-reactype/ReacType/releases/), [Linux](https://github.com/team-reactype/ReacType/releases/).
2027

0 commit comments

Comments
 (0)