oslabs-beta/Osiris

Osiris

An Electron based desktop application for generating components and storing them in a UI library.

Table of Contents

• About the Project
  • Built With
• Usage
• Getting Started
  • Prerequisites
  • Installation
• Contributing
• Contact
• Authors
• License

About The Project

Osiris is an all-in-one UI Component Library + Generator + Page Builder for developers and designers. Create and store custom, reusable components in React or Vue. Then, dynamically inject the components and manipulate their hierarchy. Finally, download the code for further development.

Built With

• Electron
• React
• PostgreSQL
• Node
• Webpack
• AWS

Usage

UI Generator and Library Features: Create custom components in React or Vue. Store your custom components securely in our UI Library powered by AWS S3

Build Page: Style and Add to Build: Easily build a React or Vue page by controlling the hierarchy of your custom components stored in your library. Customize your components by adding CSS and text

Build Page: Hierarchy & Download Code to Vue or React: Edit the hierarchy with simple arrow buttons. Choose to build your React page with/without State or Hooks. You can also build a Vue page with or without State. Lastly, download your custom page directly to your computer!

Getting Started

To get a local copy up and running follow these steps.

Prerequisite Accounts

• ElephantSQL: https://www.elephantsql.com/

• AWS S3 Bucket with Amplify: https://docs.amplify.aws/lib/storage/getting-started/q/platform/js

Installation

1. Clone the repo

git clone https://github.com/oslabs-beta/Osiris.git

2. Install NPM packages

npm install

Connect Osiris Electron App to SQL Database with ElephantSQL

1. SQL Script

CREATE TABLE individual_ui (id SERIAL PRIMARY KEY, organization_id VARCHAR, image VARCHAR, tags VARCHAR, react_code VARCHAR, file_name VARCHAR, type VARCHAR, description VARCHAR);

2. Add pgkeys.js to /src and include the following:

export const PG_URI = '<your ElephantSQL uri>'

Initialize AWS-Amplify to your project

1. Navigate to Osiris Root folder

2. Install Amplify folder following these steps:

https://docs.amplify.aws/start/getting-started/installation/q/integration/react https://docs.amplify.aws/lib/storage/getting-started/q/platform/android#initialize-amplify-storage

Run

1. Run the electron app

npm start

Contributing

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

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

Contact

Website: https://osirisdev.io

Github Link: https://github.com/oslabs-beta/Osiris/

Twitter: @osiris_io

Authors

• @Wayne Wilcox
• @Eelan Tung
• @Cameron Fitz
• @Jehovany Cruz
• @Garrett Lee

License

Distributed under the MIT License. See LICENSE for more information.