-
Notifications
You must be signed in to change notification settings - Fork 0
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
Showing
1 changed file
with
88 additions
and
134 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,159 +1,113 @@ | ||
| <img src=".erb/img/erb-banner.svg" width="100%" /> | ||
| <a name="readme-top"></a> | ||
| <br /> | ||
|
|
||
| <br> | ||
| <div align="center"> | ||
| <h3 align="center">VisualChain 🔗</h3> | ||
|
|
||
| <!-- TODO: Fix Links? --> | ||
| <p align="center"> | ||
| Create AI applications with a visual editor. | ||
| <br /> | ||
| <a href="https://github.com/xgeeks-geekathon/visualchain"><strong>Explore the docs »</strong></a> | ||
| <br /> | ||
| <br /> | ||
| <a href="https://github.com/xgeeks-geekathon/visualchain">View Demo</a> | ||
| · | ||
| <a href="https://github.com/xgeeks-geekathon/visualchain/issues">Report Bug</a> | ||
| · | ||
| <a href="https://github.com/xgeeks-geekathon/visualchain/issues">Request Feature</a> | ||
| </p> | ||
| </div> | ||
|
|
||
| <p> | ||
| Electron React Boilerplate uses <a href="https://electron.atom.io/">Electron</a>, <a href="https://facebook.github.io/react/">React</a>, <a href="https://github.com/reactjs/react-router">React Router</a>, <a href="https://webpack.js.org/">Webpack</a> and <a href="https://www.npmjs.com/package/react-refresh">React Fast Refresh</a>. | ||
| </p> | ||
| ## About The Project | ||
|
|
||
| <br> | ||
| VisualChain 🔗 is a simple visual editor that allows the user to generate code based on Nodes. You can then download, execute and have AI explain what you just generated. | ||
|
|
||
| <div align="center"> | ||
| <p align="right">(<a href="#readme-top">back to top</a>)</p> | ||
|
|
||
| [![Build Status][github-actions-status]][github-actions-url] | ||
| [![Github Tag][github-tag-image]][github-tag-url] | ||
| [](https://discord.gg/Fjy3vfgy5q) | ||
| ## Getting Started | ||
|
|
||
| [](#backers) | ||
| [](#sponsors) | ||
| [![StackOverflow][stackoverflow-img]][stackoverflow-url] | ||
| Follow these steps in order to setup the project locally. | ||
|
|
||
| </div> | ||
| ### Prerequisites | ||
|
|
||
| ## Install | ||
| - [node.js](https://nodejs.org/en/) | ||
| - [python](https://python.org/) | ||
|
|
||
| Clone the repo and install dependencies: | ||
| ### Installation | ||
|
|
||
| ```bash | ||
| git clone --depth 1 --branch main https://github.com/electron-react-boilerplate/electron-react-boilerplate.git your-project-name | ||
| cd your-project-name | ||
| npm install | ||
| 1. Clone the repo | ||
|
|
||
| ```sh | ||
| git clone https://github.com/xgeeks-geekathon/visualchain.git | ||
| ``` | ||
|
|
||
| **Having issues installing? See our [debugging guide](https://github.com/electron-react-boilerplate/electron-react-boilerplate/issues/400)** | ||
| 2. Install NPM Packages | ||
|
|
||
| ## Starting Development | ||
| ```sh | ||
| npm install | ||
| ``` | ||
|
|
||
| Start the app in the `dev` environment: | ||
| 3. Install Python Library | ||
|
|
||
| ```bash | ||
| npm start | ||
| ```sh | ||
| pip install openai | ||
| ``` | ||
|
|
||
| ## Packaging for Production | ||
| <p align="right">(<a href="#readme-top">back to top</a>)</p> | ||
|
|
||
| ## Usage | ||
|
|
||
| To package apps for the local platform: | ||
| To run the script: | ||
|
|
||
| ```bash | ||
| npm run package | ||
| ```sh | ||
| npm run start | ||
| ``` | ||
|
|
||
| ## Docs | ||
|
|
||
| See our [docs and guides here](https://electron-react-boilerplate.js.org/docs/installation) | ||
|
|
||
| ## Community | ||
|
|
||
| Join our Discord: https://discord.gg/Fjy3vfgy5q | ||
|
|
||
| ## Sponsors | ||
|
|
||
| <a href="https://palette.dev"> | ||
| <img src=".erb/img/palette-sponsor-banner.svg" width="100%" /> | ||
| </a> | ||
|
|
||
| ## Donations | ||
|
|
||
| **Donations will ensure the following:** | ||
|
|
||
| - 🔨 Long term maintenance of the project | ||
| - 🛣 Progress on the [roadmap](https://electron-react-boilerplate.js.org/docs/roadmap) | ||
| - 🐛 Quick responses to bug reports and help requests | ||
|
|
||
| ## Backers | ||
|
|
||
| Support us with a monthly donation and help us continue our activities. [[Become a backer](https://opencollective.com/electron-react-boilerplate-594#backer)] | ||
|
|
||
| <a href="https://opencollective.com/electron-react-boilerplate-594/backer/0/website" target="_blank"><img src="https://opencollective.com/electron-react-boilerplate-594/backer/0/avatar.svg"></a> | ||
| <a href="https://opencollective.com/electron-react-boilerplate-594/backer/1/website" target="_blank"><img src="https://opencollective.com/electron-react-boilerplate-594/backer/1/avatar.svg"></a> | ||
| <a href="https://opencollective.com/electron-react-boilerplate-594/backer/2/website" target="_blank"><img src="https://opencollective.com/electron-react-boilerplate-594/backer/2/avatar.svg"></a> | ||
| <a href="https://opencollective.com/electron-react-boilerplate-594/backer/3/website" target="_blank"><img src="https://opencollective.com/electron-react-boilerplate-594/backer/3/avatar.svg"></a> | ||
| <a href="https://opencollective.com/electron-react-boilerplate-594/backer/4/website" target="_blank"><img src="https://opencollective.com/electron-react-boilerplate-594/backer/4/avatar.svg"></a> | ||
| <a href="https://opencollective.com/electron-react-boilerplate-594/backer/5/website" target="_blank"><img src="https://opencollective.com/electron-react-boilerplate-594/backer/5/avatar.svg"></a> | ||
| <a href="https://opencollective.com/electron-react-boilerplate-594/backer/6/website" target="_blank"><img src="https://opencollective.com/electron-react-boilerplate-594/backer/6/avatar.svg"></a> | ||
| <a href="https://opencollective.com/electron-react-boilerplate-594/backer/7/website" target="_blank"><img src="https://opencollective.com/electron-react-boilerplate-594/backer/7/avatar.svg"></a> | ||
| <a href="https://opencollective.com/electron-react-boilerplate-594/backer/8/website" target="_blank"><img src="https://opencollective.com/electron-react-boilerplate-594/backer/8/avatar.svg"></a> | ||
| <a href="https://opencollective.com/electron-react-boilerplate-594/backer/9/website" target="_blank"><img src="https://opencollective.com/electron-react-boilerplate-594/backer/9/avatar.svg"></a> | ||
| <a href="https://opencollective.com/electron-react-boilerplate-594/backer/10/website" target="_blank"><img src="https://opencollective.com/electron-react-boilerplate-594/backer/10/avatar.svg"></a> | ||
| <a href="https://opencollective.com/electron-react-boilerplate-594/backer/11/website" target="_blank"><img src="https://opencollective.com/electron-react-boilerplate-594/backer/11/avatar.svg"></a> | ||
| <a href="https://opencollective.com/electron-react-boilerplate-594/backer/12/website" target="_blank"><img src="https://opencollective.com/electron-react-boilerplate-594/backer/12/avatar.svg"></a> | ||
| <a href="https://opencollective.com/electron-react-boilerplate-594/backer/13/website" target="_blank"><img src="https://opencollective.com/electron-react-boilerplate-594/backer/13/avatar.svg"></a> | ||
| <a href="https://opencollective.com/electron-react-boilerplate-594/backer/14/website" target="_blank"><img src="https://opencollective.com/electron-react-boilerplate-594/backer/14/avatar.svg"></a> | ||
| <a href="https://opencollective.com/electron-react-boilerplate-594/backer/15/website" target="_blank"><img src="https://opencollective.com/electron-react-boilerplate-594/backer/15/avatar.svg"></a> | ||
| <a href="https://opencollective.com/electron-react-boilerplate-594/backer/16/website" target="_blank"><img src="https://opencollective.com/electron-react-boilerplate-594/backer/16/avatar.svg"></a> | ||
| <a href="https://opencollective.com/electron-react-boilerplate-594/backer/17/website" target="_blank"><img src="https://opencollective.com/electron-react-boilerplate-594/backer/17/avatar.svg"></a> | ||
| <a href="https://opencollective.com/electron-react-boilerplate-594/backer/18/website" target="_blank"><img src="https://opencollective.com/electron-react-boilerplate-594/backer/18/avatar.svg"></a> | ||
| <a href="https://opencollective.com/electron-react-boilerplate-594/backer/19/website" target="_blank"><img src="https://opencollective.com/electron-react-boilerplate-594/backer/19/avatar.svg"></a> | ||
| <a href="https://opencollective.com/electron-react-boilerplate-594/backer/20/website" target="_blank"><img src="https://opencollective.com/electron-react-boilerplate-594/backer/20/avatar.svg"></a> | ||
| <a href="https://opencollective.com/electron-react-boilerplate-594/backer/21/website" target="_blank"><img src="https://opencollective.com/electron-react-boilerplate-594/backer/21/avatar.svg"></a> | ||
| <a href="https://opencollective.com/electron-react-boilerplate-594/backer/22/website" target="_blank"><img src="https://opencollective.com/electron-react-boilerplate-594/backer/22/avatar.svg"></a> | ||
| <a href="https://opencollective.com/electron-react-boilerplate-594/backer/23/website" target="_blank"><img src="https://opencollective.com/electron-react-boilerplate-594/backer/23/avatar.svg"></a> | ||
| <a href="https://opencollective.com/electron-react-boilerplate-594/backer/24/website" target="_blank"><img src="https://opencollective.com/electron-react-boilerplate-594/backer/24/avatar.svg"></a> | ||
| <a href="https://opencollective.com/electron-react-boilerplate-594/backer/25/website" target="_blank"><img src="https://opencollective.com/electron-react-boilerplate-594/backer/25/avatar.svg"></a> | ||
| <a href="https://opencollective.com/electron-react-boilerplate-594/backer/26/website" target="_blank"><img src="https://opencollective.com/electron-react-boilerplate-594/backer/26/avatar.svg"></a> | ||
| <a href="https://opencollective.com/electron-react-boilerplate-594/backer/27/website" target="_blank"><img src="https://opencollective.com/electron-react-boilerplate-594/backer/27/avatar.svg"></a> | ||
| <a href="https://opencollective.com/electron-react-boilerplate-594/backer/28/website" target="_blank"><img src="https://opencollective.com/electron-react-boilerplate-594/backer/28/avatar.svg"></a> | ||
| <a href="https://opencollective.com/electron-react-boilerplate-594/backer/29/website" target="_blank"><img src="https://opencollective.com/electron-react-boilerplate-594/backer/29/avatar.svg"></a> | ||
|
|
||
| ## Sponsors | ||
|
|
||
| Become a sponsor and get your logo on our README on Github with a link to your site. [[Become a sponsor](https://opencollective.com/electron-react-boilerplate-594-594#sponsor)] | ||
|
|
||
| <a href="https://opencollective.com/electron-react-boilerplate-594/sponsor/0/website" target="_blank"><img src="https://opencollective.com/electron-react-boilerplate-594/sponsor/0/avatar.svg"></a> | ||
| <a href="https://opencollective.com/electron-react-boilerplate-594/sponsor/1/website" target="_blank"><img src="https://opencollective.com/electron-react-boilerplate-594/sponsor/1/avatar.svg"></a> | ||
| <a href="https://opencollective.com/electron-react-boilerplate-594/sponsor/2/website" target="_blank"><img src="https://opencollective.com/electron-react-boilerplate-594/sponsor/2/avatar.svg"></a> | ||
| <a href="https://opencollective.com/electron-react-boilerplate-594/sponsor/3/website" target="_blank"><img src="https://opencollective.com/electron-react-boilerplate-594/sponsor/3/avatar.svg"></a> | ||
| <a href="https://opencollective.com/electron-react-boilerplate-594/sponsor/4/website" target="_blank"><img src="https://opencollective.com/electron-react-boilerplate-594/sponsor/4/avatar.svg"></a> | ||
| <a href="https://opencollective.com/electron-react-boilerplate-594/sponsor/5/website" target="_blank"><img src="https://opencollective.com/electron-react-boilerplate-594/sponsor/5/avatar.svg"></a> | ||
| <a href="https://opencollective.com/electron-react-boilerplate-594/sponsor/6/website" target="_blank"><img src="https://opencollective.com/electron-react-boilerplate-594/sponsor/6/avatar.svg"></a> | ||
| <a href="https://opencollective.com/electron-react-boilerplate-594/sponsor/7/website" target="_blank"><img src="https://opencollective.com/electron-react-boilerplate-594/sponsor/7/avatar.svg"></a> | ||
| <a href="https://opencollective.com/electron-react-boilerplate-594/sponsor/8/website" target="_blank"><img src="https://opencollective.com/electron-react-boilerplate-594/sponsor/8/avatar.svg"></a> | ||
| <a href="https://opencollective.com/electron-react-boilerplate-594/sponsor/9/website" target="_blank"><img src="https://opencollective.com/electron-react-boilerplate-594/sponsor/9/avatar.svg"></a> | ||
| <a href="https://opencollective.com/electron-react-boilerplate-594/sponsor/10/website" target="_blank"><img src="https://opencollective.com/electron-react-boilerplate-594/sponsor/10/avatar.svg"></a> | ||
| <a href="https://opencollective.com/electron-react-boilerplate-594/sponsor/11/website" target="_blank"><img src="https://opencollective.com/electron-react-boilerplate-594/sponsor/11/avatar.svg"></a> | ||
| <a href="https://opencollective.com/electron-react-boilerplate-594/sponsor/12/website" target="_blank"><img src="https://opencollective.com/electron-react-boilerplate-594/sponsor/12/avatar.svg"></a> | ||
| <a href="https://opencollective.com/electron-react-boilerplate-594/sponsor/13/website" target="_blank"><img src="https://opencollective.com/electron-react-boilerplate-594/sponsor/13/avatar.svg"></a> | ||
| <a href="https://opencollective.com/electron-react-boilerplate-594/sponsor/14/website" target="_blank"><img src="https://opencollective.com/electron-react-boilerplate-594/sponsor/14/avatar.svg"></a> | ||
| <a href="https://opencollective.com/electron-react-boilerplate-594/sponsor/15/website" target="_blank"><img src="https://opencollective.com/electron-react-boilerplate-594/sponsor/15/avatar.svg"></a> | ||
| <a href="https://opencollective.com/electron-react-boilerplate-594/sponsor/16/website" target="_blank"><img src="https://opencollective.com/electron-react-boilerplate-594/sponsor/16/avatar.svg"></a> | ||
| <a href="https://opencollective.com/electron-react-boilerplate-594/sponsor/17/website" target="_blank"><img src="https://opencollective.com/electron-react-boilerplate-594/sponsor/17/avatar.svg"></a> | ||
| <a href="https://opencollective.com/electron-react-boilerplate-594/sponsor/18/website" target="_blank"><img src="https://opencollective.com/electron-react-boilerplate-594/sponsor/18/avatar.svg"></a> | ||
| <a href="https://opencollective.com/electron-react-boilerplate-594/sponsor/19/website" target="_blank"><img src="https://opencollective.com/electron-react-boilerplate-594/sponsor/19/avatar.svg"></a> | ||
| <a href="https://opencollective.com/electron-react-boilerplate-594/sponsor/20/website" target="_blank"><img src="https://opencollective.com/electron-react-boilerplate-594/sponsor/20/avatar.svg"></a> | ||
| <a href="https://opencollective.com/electron-react-boilerplate-594/sponsor/21/website" target="_blank"><img src="https://opencollective.com/electron-react-boilerplate-594/sponsor/21/avatar.svg"></a> | ||
| <a href="https://opencollective.com/electron-react-boilerplate-594/sponsor/22/website" target="_blank"><img src="https://opencollective.com/electron-react-boilerplate-594/sponsor/22/avatar.svg"></a> | ||
| <a href="https://opencollective.com/electron-react-boilerplate-594/sponsor/23/website" target="_blank"><img src="https://opencollective.com/electron-react-boilerplate-594/sponsor/23/avatar.svg"></a> | ||
| <a href="https://opencollective.com/electron-react-boilerplate-594/sponsor/24/website" target="_blank"><img src="https://opencollective.com/electron-react-boilerplate-594/sponsor/24/avatar.svg"></a> | ||
| <a href="https://opencollective.com/electron-react-boilerplate-594/sponsor/25/website" target="_blank"><img src="https://opencollective.com/electron-react-boilerplate-594/sponsor/25/avatar.svg"></a> | ||
| <a href="https://opencollective.com/electron-react-boilerplate-594/sponsor/26/website" target="_blank"><img src="https://opencollective.com/electron-react-boilerplate-594/sponsor/26/avatar.svg"></a> | ||
| <a href="https://opencollective.com/electron-react-boilerplate-594/sponsor/27/website" target="_blank"><img src="https://opencollective.com/electron-react-boilerplate-594/sponsor/27/avatar.svg"></a> | ||
| <a href="https://opencollective.com/electron-react-boilerplate-594/sponsor/28/website" target="_blank"><img src="https://opencollective.com/electron-react-boilerplate-594/sponsor/28/avatar.svg"></a> | ||
| <a href="https://opencollective.com/electron-react-boilerplate-594/sponsor/29/website" target="_blank"><img src="https://opencollective.com/electron-react-boilerplate-594/sponsor/29/avatar.svg"></a> | ||
|
|
||
| ## Maintainers | ||
|
|
||
| - [Amila Welihinda](https://github.com/amilajack) | ||
| - [John Tran](https://github.com/jooohhn) | ||
| - [C. T. Lin](https://github.com/chentsulin) | ||
| - [Jhen-Jie Hong](https://github.com/jhen0409) | ||
| ## Roadmap | ||
|
|
||
| - [x] Version 1.0 | ||
|
|
||
| See the [open issues](https://github.com/xgeeks-geekathon/visualchain/issues) for a full list of proposed features (and known issues). | ||
|
|
||
| <p align="right">(<a href="#readme-top">back to top</a>)</p> | ||
|
|
||
| ## Contributing | ||
|
|
||
| Contributions are what make the open source community such an amazing place to learn, inspire, and create. Any contributions you make are **greatly appreciated**. | ||
|
|
||
| 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". | ||
| Don't forget to give the project a star! Thanks again! | ||
|
|
||
| 1. Fork the Project | ||
| 2. Create your Feature Branch (`git checkout -b feature/AmazingFeature`) | ||
| 3. Commit your Changes (`git commit -m 'Add some AmazingFeature'`) | ||
| 4. Push to the Branch (`git push origin feature/AmazingFeature`) | ||
| 5. Open a Pull Request | ||
|
|
||
| <p align="right">(<a href="#readme-top">back to top</a>)</p> | ||
|
|
||
| <!-- LICENSE --> | ||
|
|
||
| ## License | ||
|
|
||
| MIT © [Electron React Boilerplate](https://github.com/electron-react-boilerplate) | ||
| Distributed under the MIT License. See `LICENSE.md` for more information. | ||
|
|
||
| <p align="right">(<a href="#readme-top">back to top</a>)</p> | ||
|
|
||
| <!-- CONTACT --> | ||
|
|
||
| ## Contact | ||
|
|
||
| DevDuckies Team | ||
|
|
||
| <p align="right">(<a href="#readme-top">back to top</a>)</p> | ||
|
|
||
| <!-- ACKNOWLEDGMENTS --> | ||
|
|
||
| ## Acknowledgments | ||
|
|
||
| - [Electron](https://www.electronjs.org/) | ||
| - [ReactFlow](https://reactflow.dev/) | ||
|
|
||
| [github-actions-status]: https://github.com/electron-react-boilerplate/electron-react-boilerplate/workflows/Test/badge.svg | ||
| [github-actions-url]: https://github.com/electron-react-boilerplate/electron-react-boilerplate/actions | ||
| [github-tag-image]: https://img.shields.io/github/tag/electron-react-boilerplate/electron-react-boilerplate.svg?label=version | ||
| [github-tag-url]: https://github.com/electron-react-boilerplate/electron-react-boilerplate/releases/latest | ||
| [stackoverflow-img]: https://img.shields.io/badge/stackoverflow-electron_react_boilerplate-blue.svg | ||
| [stackoverflow-url]: https://stackoverflow.com/questions/tagged/electron-react-boilerplate | ||
| <p align="right">(<a href="#readme-top">back to top</a>)</p> |