ReacType is a rapid prototyping tool built on Electron that allows users visualize their application architecture dynamically, employing a drag-and-drop canvas display and an interactive, real-time component code preview that can be exported as a React app for developers employing React component architecture alongside the comprehensive type-checking of TypeScript. In other words, you can draw prototypes and export React / TypeScript code!
Visit reactype.dev to learn more about the product.
Follow @ReacType on Twitter for important announcements.
If you want to read about using ReacType, the User Manual is free and available online now.
-
MacOS Download the latest release
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. If you are given a warning that Apple could not scan the app. Please follow these steps -
Windows Download the latest release
- Consolidated State Management: Reactype was using mutliple methods of State Management. We consolidated this all to the modern version of Redux Toolkit to enhance the developer experience and make it easier to debug.
- Major Dependency Updates: No more workarounds required to get new developers up and running in the project. A simple npm install works as intended.
- Websockets: Users can now join rooms to collaborate on a project together in real time!
- Fully Deployed Web Application: To utilize these new features we have hosted the full application via AWS so users can easily use Reactype without a download.
- And more: See change log for more details on what was changed from the previous versions as well as plans for upcoming features!
Here is the main file structure:
Please refer to the link: https://excalidraw.com/#json=JKwzVD5qx6lsfiHW1_pQ9,XJ6uDoehVu-1bsx0SMlC6w for more details.- Fork and Clone Repository.
- Open project directory
- Install dependencies.
npm install
- To run the production build
npm run prod
- To run tests
npm run test
- To run the development build
npm run dev
-
Note that a .env with DEV_PORT, and a NODE_ENV flag (=production or development) are needed.
-
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. 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.) -
To run the development build of electron app
npm run dev
npm run electron-dev
- Open exported project directory
- Install dependencies
npm install
- Build the app
npm run build
- Start an instance
npm run start
- Open browser and navigate to localhost at specified port
Typescript, React.js, Redux, Javascript, D3.js, Node.js (Express), HTML, CSS/SASS, GraphQL, Next.js, Gatsby.js, Electron, SQL, NoSQL, Webpack, TDD (Jest, Enzyme and React Testing Library), OAuth 2.0, Travis CI
Here is the up to date list of all co-developers of this product. Please visit our contribution documentation for more information on how you can contribute to ReacType!
This project is licensed under the MIT License - see the LICENSE.md file for details.