You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: LICENSE.md
+1-1
Original file line number
Diff line number
Diff line change
@@ -1,6 +1,6 @@
1
1
MIT License
2
2
3
-
Copyright (c) 2020 ReacType
3
+
Copyright (c) 2021 ReacType
4
4
5
5
Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:
**ReacType** is a visual prototyping tool for developers employing **React** component architecture alongside the comprehensive typechecking of **TypeScript**.
11
-
In other words, **you can draw prototypes and export React / Typescript code!**
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!**
12
12
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.
13
+
**ReacType** allows users to _visualize_ their application architecture dynamically, employing a _drag-and-drop canvas display_ and a _real-time component code preview_. Users 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.
14
14
15
-
**New with version 4.0:**
16
15
17
-
- View dynamically created components/HTML elements in the component tree
18
-
- View Typescript syntax for React
19
-
-Code preview is fully editable (make changes before exporting project)
20
-
-Create custom HTML elements
21
-
-Improved UI experience
22
-
-Implemented a comprehensive tutorial page with images
16
+
**New with version 5.0:**
17
+
18
+
-Elements may be added to components in any location, rather than only at the bottom
19
+
-Compatibility with Gatsby.js
20
+
-Modernized and cleaner UI, including enhanced dark mode
21
+
-Tutorial has been updated to reflect other modifications
23
22
24
23
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/).
25
24
26
25
-**Mac users**: After opening the dmg and dragging ReacType into your Applications folder, ctrl+click the icon and select 'Open' from the context menu to run the app. This extra step is necessary since we don't have an Apple developer license yet.
27
26
28
-
-**Windows users**: Install the application by running ReacType Setup 4.0.0.exe.
27
+
-**Windows users**: Install the application by running ReacType Setup 5.0.0.exe.
29
28
30
29
-**Linux users**: Run the application as a super user in order to read and write files.
31
30
32
-

31
+

33
32
34
33
### How to use
35
34
36
-
-**Sign-in page**: Sign up for an account, authenticate via Github/Facebook, or just continue as a guest.
37
-
-**Tutorial**: Click ‘Tutorial’ from the help tab’s drop-down menu of the help tab at the top left of the application to view a tutorial page.
38
-
-**Start a project (only after authenticating)**: After you authenticate via Github/Facebook, create a new project, and select whether you want your project to be a Next.jsor a classic React project. Also, save your project so that you can return to it at a later time.
39
-
-**Add Components**: Create components on the left panel. Components can be associated with a route, or they can be used within other components.
40
-
-**Delete Components**: Delete components after focusing on them from the right panel. Be careful when deleting components because all instances of the component will be deleted within the application/project.
41
-
-**Add Custom Elements**: Create custom elements or add HTML elements that you are more familiar with into the application. Once the project is exported, the HTML tags generated in the code preview will function the way the label is supposed to work. You can create functionality for custom elements in a new file. The tutorial on HTML Elements explains more on how to do this.
42
-
-**Delete Elements**: Delete elements by clicking on the ‘X’ button next to the element. Be careful when deleting elements because all elements will be deleted within the application/project.
43
-
-**Create instances on the canvas**: Each component has its canvas. Create an example of an element or HTML element by dragging it onto the canvas. Div components are arbitrarily nestable and useful for complex layouts. Next.js projects have Link components to enable client-side navigation to other routes.
44
-
-**Component Tree**: Click on the component tree tab next to the code preview tab to view the component tree hierarchy.
45
-
-**Update styling**: Click on an element on the canvas to update basic styling using the right functions. As you create new instances and add styling, watch as your code dynamically generates in the bottom panel.
46
-
-**User preference features**: Select a theme for the code preview to your liking and change the application’s lighting.
47
-
-**Export project**: Click the “Export Project’ button to export the project’s application files into a Typescript file. The exported project is fully functional with Webpack, Express server, routing, etc., and will match what’s mocked on the canvas.
35
+
-**Sign-in page**: Sign up for an account, or just continue as a guest. Registered users enjoy additional project-saving functionality.
36
+
-**Tutorial**: Click ‘Tutorial’ from the Help tab’s dropdown menu (at the top left of the application) to view a tutorial.
37
+
-**Start a project (only after registration)**: Registered users can create a new project and select whether they want their project to be a Next.js, Gatsby.js, or classic React project. Also, registered users can save projects to return to them at a later time.
38
+
-**Add Components**: Create components on the right panel. Components can be associated with a route, or they can be used within other components.
39
+
-**Delete Components**: Delete components after focusing on them in the right panel. Be careful when deleting components: Upon deletion, all instances of the component will be removed within the application/project.
40
+
-**Add Custom Elements**: Create custom elements or add provided HTML elements into the application. Once the project is exported, the HTML tags generated in the code preview will function as expected. You can specify functionality for custom elements in the code preview. The tutorial on HTML Elements explains more on how to do this.
41
+
-**Delete Custom HTML Elements**: Delete custom HTML elements by clicking on the ‘X’ button adjacent to the element. Be careful when deleting custom elements: All instances of the element will be deleted within the application/project.
42
+
-**Create Instances on the Canvas**: Each component has its own canvas. Add an element to a component by dragging it onto the canvas. Div components are arbitrarily nestable and useful for complex layouts. Next.js and Gatsby.js projects have Link components to enable client-side navigation to other routes.
43
+
-**Component Tree**: Click on the Component Tree tab next to the Code Preview tab to view the component tree hierarchy.
44
+
-**Update Styling**: Select an element on the canvas to update its basic style attributes on the right panel. As you create new instances and add styling, watch as your code dynamically generates in the code preview in the bottom panel.
45
+
-**User Preference Features**: With the click of a button, toggle between light mode and dark mode, depending on your preference.
46
+
-**Export project**: Click the “Export Project’ button to export the project’s application files into a TypeScript file. The exported project is fully functional with Webpack, Express server, routing, etc., and will match what is mocked on the canvas.
- Please note that the development build is not connected to the production server. `npm run dev` should spin up the development server from the server folder of this repo. For additional information, the readme is [here](https://github.com/open-source-labs/ReacType/blob/master/server/README.md). Alternatively, you can also select "Continue as guest" on the log-in page of the app to not use any features that rely on the server (authentication and saving project data.)
124
+
- Please note that the development build is not connected to the production server. `npm run dev` should spin up the development server from the server folder of this repo. For additional information, the readme is [here](https://github.com/open-source-labs/ReacType/blob/master/server/README.md). Alternatively, you can select "Continue as guest" on the login page of the app, which will not use any features that rely on the server (authentication and saving project data.)
118
125
119
-
## To Run Your Exported Next.js Project
126
+
## To Run Your Exported Next.js or Gatsby.js Project
0 commit comments