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
Ever feel like getting started with a React App takes too many files and too much boilerplate code?
64
+
65
+
Meet fflow.
62
66
63
67
fflow is a frontend developer tool to create React applications in no time and with minimal effort using the simple drag and drop UI. It combines the most compelling features of Create React App, React ES6 snippets, and a beautiful user experience.
64
68
65
-
👉 https://fflow.dev
69
+
We are really excited to launch our alpha version and hope you will download, play around with it, and provide us feedback.
70
+
71
+
Visit our website here 👉 https://fflow.dev
66
72
67
73
GIFS to be inserted here and centered aligned
68
74
@@ -71,14 +77,14 @@ GIFS to be inserted here and centered aligned
71
77
- Drag, Drop, Reorder and Delete HTML Tags
72
78
- Create Custom React Components
73
79
- Light and Dark Theme based on OS Preferences and Manual Toggle
74
-
- Delete Project to restart project
75
-
-Clear current canvas to restart nesting in a component
76
-
-Live preview in code editor with the ability to edit or add code to your JavaScript, HTML, and CSS files
77
-
-File tree switch between React components
78
-
-Export your code files with webpack to instantly setup your project
79
-
-Terminal initializing to the either powershell.exe or zsh based on the user's OS, so the user can navigate to their exported files and launch their app
80
-
-Localstorage sync
81
-
-Canvas outline when HTML tag or Component is dragged over it
80
+
- Delete Project and Clear Canvas to restart build process
81
+
-Live preview in Code editor
82
+
-Interactable CSS Code Editor
83
+
-Easily switch between files with file tree or on the canvas
84
+
-Easy redirect to App.jsx by clicking on the fflow icon
85
+
-Export app with preconfigured and versatile webpack
86
+
-In-built terminal initializes an instance of the exported app without leaving fflow
87
+
-Accessibility features including canvas item highlighting when the HTML tag or Component is picked up
82
88
83
89
### Built with
84
90
@@ -106,94 +112,47 @@ The following instructions are split into two sections for:
106
112
-[Production Mode](#production-mode)
107
113
-[Development Mode](#development-mode)
108
114
109
-
### Production Mode
115
+
## Production Mode
116
+
117
+
Please download the latest release of fflow for [MacOS](https://github.com/oslabs-beta/fflow/releases) or [Windows](https://github.com/oslabs-beta/fflow/releases).
Download for [MacOS](https://github.com/oslabs-beta/fflow/releases), [Windows](https://github.com/oslabs-beta/fflow/releases), [Linux](https://github.com/oslabs-beta/fflow/releases).
121
+
💫 Linux version coming soon. 💫
112
122
113
123
-**Mac users**: After opening the dmg and dragging fflow into your Applications folder, `CTL + Click` the icon and 'Open' from the context menu to open the app. This extra step is necessary since we don't have an Apple developer license yet.
114
124
115
125
-**Windows users**: Install the application by running fflow setup 1.0.0.exe.
116
126
117
-
-**Linux users**: Run the application as a super user in order to read and write files.
118
-
119
-
### Keyboard Shortcuts (Mac and Windows)
120
-
121
-
| Shortcut | Description |
122
-
| ---------------- | ------------------------- |
123
-
|`cmd+e``ctrl+e`| Export Project |
124
-
|`cmd+z``ctrl+z`| Undo last action |
125
-
|`cmd+y``ctrl+y`| Redo action |
126
-
|`del`| Delete selected component |
127
-
|`c`| Toggle Code panel |
128
-
|`t`| Toggle directory tree |
129
-
130
-
<details>
131
-
<summary>Mac Shortcuts</summary>
132
-
<ul>
133
-
<li>Export Project: Command + e</li>
134
-
<li>Undo: Command + z</li>
135
-
<li>Redo: Command + Shift + z</li>
136
-
<li>Save Project As: Command + s</li>
137
-
<li>Save Project: Command + shift + s</li>
138
-
<li>Delete HTML Tag on Canvas: Backspace</li>
139
-
<li>Delete Project: Command + Backspace</li>
140
-
<li>Open Project: Command + o</li>
141
-
</ul>
142
-
</details>
127
+
<!-- - **Linux users**: Run the application as a super user in order to read and write files. -->
143
128
144
-
<details>
145
-
<summary>Windows Shortcuts</summary>
146
-
<ul>
147
-
<li>Export Project: Control + e</li>
148
-
<li>Undo: Control + z</li>
149
-
<li>Redo: Control + Shift + z</li>
150
-
<li>Save Project As: Control + s</li>
151
-
<li>Save Project: Control + shift + s</li>
152
-
<li>Delete HTML Tag on Canvas: Backspace</li>
153
-
<li>Delete Project: Control + Backspace</li>
154
-
<li>Open Project: Control + o</li>
155
-
</ul>
156
-
</details>
129
+
<!-- #### Drag, Drop, Reorder and Delete HTML Tags onto Canvas
157
130
158
-
###Development Mode
131
+
#### Nest HTML Tags and Components within custom React Components
159
132
160
-
#### Clone this repo
133
+
#### Style your project
161
134
162
-
1. Clone this repo
135
+
Add styles to your HTML elements and React Components by editing directly in the CSS Editor. This will then be exported with your app.
163
136
164
-
```
165
-
git clone https://github.com/oslabs-beta/fflow
166
-
```
137
+
#### Clearing the Canvas
167
138
168
-
2. Install the dependencies
139
+
## Development Mode -->
169
140
170
-
```
171
-
npm install
172
-
```
141
+
#### Clone this repo
173
142
174
-
3. Run script for development mode
143
+
1. Clone this repo `git clone https://github.com/oslabs-beta/fflow`
144
+
2. Install the dependencies `npm install`
145
+
3. Run script for development mode `npm run start`
146
+
4. Build the app (automatic) `npm run build`
147
+
5. Test the app (after `npm run build` || `yarn run build`) `npm run prod`
175
148
176
-
```
177
-
npm run start
178
-
```
149
+
Note there is currently an issue where the Monaco Code Editor keeps showing 'loading...' in development mode. We are working to solve this. In the meantime, when you drag HTML tags onto canvas you can still see the code editor's contents in the Developer Tools.
179
150
180
-
4. Build the app (automatic)
151
+
#### Node versioning error
181
152
182
-
```
183
-
npm run package
184
-
```
153
+
#### Running tests
185
154
186
-
5. Build the app (manual)
187
-
188
-
```
189
-
npm run build
190
-
```
191
-
192
-
6. Test the app (after `npm run build` || `yarn run build`)
193
-
194
-
```
195
-
npm run prod
196
-
```
155
+
Instructions coming soon.
197
156
198
157
<palign="right">(<ahref="#top">back to top</a>)</p>
199
158
@@ -217,20 +176,10 @@ Below is the generated directory structure of the React and Webpack application
217
176
218
177
```
219
178
220
-
1. Open exported project directory in your Downloads folder
221
-
2. Install dependencies
222
-
223
-
```
224
-
npm install
225
-
```
226
-
179
+
1. Using the inbuilt terminal, `cd` into the Exported Project in your `Downloads` folder
180
+
2. In the root of the Exported Project folder, install dependencies `npm install`
227
181
3. Start an instance
228
-
229
-
```
230
-
npm run start
231
-
```
232
-
233
-
4.`Localhost:8080` should open automatically in your default browser. If it does not, open browser and navigate to the specified port
182
+
4. If `Localhost:8080` does not open automatically in your default browser, navigate to the specified port to see your running app with Hot Module Reloading and a pre-configured webpack
234
183
235
184
<br />
236
185
@@ -303,31 +252,37 @@ This boilerplate names your project `Exported Project`. You can change the app t
<palign="right">(<ahref="#top">back to top</a>)</p>
307
258
308
259
## Roadmap
309
260
261
+
- Editable JS Code Preview
310
262
- GitHub OAuth Integration and online project save
263
+
- Keyboard shortcuts for Mac and Windows
311
264
- Export in TypeScript
312
265
- Save Multiple Projects
313
266
- Create Custom HTML Elements
314
267
- Open and compose multiple projects in different windows simultaneously
315
-
- Dynamic CSS and HTML Editor
316
268
- BrowserView to preview project
317
269
- Live Editing with other collaborators
318
270
- AWS hosted version
319
271
272
+
<palign="right">(<ahref="#top">back to top</a>)</p>
273
+
320
274
## Contributing Guide
321
275
322
276
Contributions are what make the open source community an amazing place to learn, inspire, and create. Any contributions are greatly appreciated.
323
277
324
-
If you have a suggestion that would make this better, please fork the repo and create a pull request. You can also simply open an issue with the tag "enhancement".
278
+
If you have a suggestion of how to make fflow better, please fork the repo and create a pull request. You can also simply open an issue with the tag "enhancement".
325
279
326
280
1. Fork this repo
327
-
2. Create your Feature Branch (git checkout -b yourgithubhandle/AmazingFeature)
328
-
3. Commit your Changes (git commit -m 'Add some AmazingFeature')
329
-
4.Push to the Branch (git push origin yourgithubhandle/AmazingFeature)
281
+
2. Create your Feature Branch (`git checkout -b` yourgithubhandle/AmazingFeature)
282
+
3. Commit your Changes (`git commit -m` 'Add some AmazingFeature')
283
+
4.Create and push to your remote branch (`git push origin` yourgithubhandle/AmazingFeature)
330
284
5. Open a Pull Request
285
+
331
286
<palign="right">(<ahref="#top">back to top</a>)</p>
332
287
333
288
<!-- Read our [contributing guide](https://github.com/oslabs-beta/CONTRIBUTING.md) for more information on how to propose fixes and improvements to fflow. -->
0 commit comments