Skip to content

Commit 791f250

Browse files
committed
Update README for Alpha release and add blue theme
1 parent 4578691 commit 791f250

19 files changed

+32627
-3102
lines changed

CONTRIBUTING.md

Lines changed: 0 additions & 11 deletions
This file was deleted.

README.md

Lines changed: 55 additions & 100 deletions
Original file line numberDiff line numberDiff line change
@@ -37,7 +37,7 @@
3737
<summary>Table of Contents</summary>
3838
<ol>
3939
<li>
40-
<a href="#about">About</a>
40+
<a href="#about">About fflow</a>
4141
<ul>
4242
<li><a href="#features">Features</a></li>
4343
<li><a href="#built-with">Built With</a></li>
@@ -58,11 +58,17 @@
5858
</ol>
5959
</details>
6060

61-
## About
61+
## About fflow
62+
63+
Ever feel like getting started with a React App takes too many files and too much boilerplate code?
64+
65+
Meet fflow.
6266

6367
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.
6468

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
6672

6773
GIFS to be inserted here and centered aligned
6874

@@ -71,14 +77,14 @@ GIFS to be inserted here and centered aligned
7177
- Drag, Drop, Reorder and Delete HTML Tags
7278
- Create Custom React Components
7379
- 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
8288

8389
### Built with
8490

@@ -106,94 +112,47 @@ The following instructions are split into two sections for:
106112
- [Production Mode](#production-mode)
107113
- [Development Mode](#development-mode)
108114

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).
118+
119+
<!-- [Linux](https://github.com/oslabs-beta/fflow/releases) -->
110120

111-
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. 💫
112122

113123
- **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.
114124

115125
- **Windows users**: Install the application by running fflow setup 1.0.0.exe.
116126

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. -->
143128

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
157130
158-
### Development Mode
131+
#### Nest HTML Tags and Components within custom React Components
159132
160-
#### Clone this repo
133+
#### Style your project
161134
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.
163136
164-
```
165-
git clone https://github.com/oslabs-beta/fflow
166-
```
137+
#### Clearing the Canvas
167138
168-
2. Install the dependencies
139+
## Development Mode -->
169140

170-
```
171-
npm install
172-
```
141+
#### Clone this repo
173142

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`
175148

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.
179150

180-
4. Build the app (automatic)
151+
#### Node versioning error
181152

182-
```
183-
npm run package
184-
```
153+
#### Running tests
185154

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.
197156

198157
<p align="right">(<a href="#top">back to top</a>)</p>
199158

@@ -217,20 +176,10 @@ Below is the generated directory structure of the React and Webpack application
217176
218177
```
219178

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`
227181
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
234183

235184
<br />
236185

@@ -303,31 +252,37 @@ This boilerplate names your project `Exported Project`. You can change the app t
303252
- Bryanna DeJesus [@BryannaDeJesus](https://github.com/BryannaDeJesus) | [Linkedin](https://www.linkedin.com/in/bryannadejesus/)
304253
- Ronak Hirpara [@ronakh130](https://github.com/ronakh130) | [Linkedin](https://www.linkedin.com/in/ronak-hirpara/)
305254

306-
Project Links: [Github](https://github.com/oslabs-beta/fflow) | [Linkedin](https://www.linkedin.com/company/fflow-io) | [Press]
255+
Project Links: [Github](https://github.com/oslabs-beta/fflow) | [Linkedin](https://www.linkedin.com/company/fflowdev) | [Press]
256+
257+
<p align="right">(<a href="#top">back to top</a>)</p>
307258

308259
## Roadmap
309260

261+
- Editable JS Code Preview
310262
- GitHub OAuth Integration and online project save
263+
- Keyboard shortcuts for Mac and Windows
311264
- Export in TypeScript
312265
- Save Multiple Projects
313266
- Create Custom HTML Elements
314267
- Open and compose multiple projects in different windows simultaneously
315-
- Dynamic CSS and HTML Editor
316268
- BrowserView to preview project
317269
- Live Editing with other collaborators
318270
- AWS hosted version
319271

272+
<p align="right">(<a href="#top">back to top</a>)</p>
273+
320274
## Contributing Guide
321275

322276
Contributions are what make the open source community an amazing place to learn, inspire, and create. Any contributions are greatly appreciated.
323277

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".
325279

326280
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)
330284
5. Open a Pull Request
285+
331286
<p align="right">(<a href="#top">back to top</a>)</p>
332287

333288
<!-- 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

Comments
 (0)