Need help with Osiris?
Click the “chat” button below for chat support from the developer who created it, or find similar developers for support.

About the developer

oslabs-beta
178 Stars 7 Forks MIT License 163 Commits 0 Opened issues

Description

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

Services available

!
?

Need anything else?

Contributors list

No Data


Logo

Osiris

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


Table of Contents

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

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!

buildpage2


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
    sh
    git clone https://github.com/oslabs-beta/Osiris.git
    
  2. Install NPM packages

    sh
    npm install
    

    Connect Osiris Electron App to SQL Database with ElephantSQL

  3. SQL Script

    sh
    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);
    
  4. Add pgkeys.js to /src and include the following:

    sh
    export const PG_URI = ''
    

    Initialize AWS-Amplify to your project

  5. Navigate to Osiris Root folder

  6. 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
    sh
    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

License

Distributed under the MIT License. See

LICENSE
for more information.

We use cookies. If you continue to browse the site, you agree to the use of cookies. For more information on our use of cookies please see our Privacy Policy.