Osiris

Overview

Osiris is a desktop application built with Electron that serves as an all-in-one UI Component Library, Generator, and Page Builder for developers and designers. It allows users to create and store custom reusable components in React or Vue, manipulate their hierarchy, and download the code for further development.

Features

• UI Generator and Library: Create custom components in React or Vue and securely store them in the UI library powered by AWS S3.
• Build Page: Easily build React or Vue pages by controlling the hierarchy of custom components stored in the library. Customize components with CSS and text.
• Hierarchy & Download Code: Edit the hierarchy with simple arrow buttons. Build React pages with state or hooks, or build Vue pages with or without state. Download custom pages directly to your computer.

Installation

To get a local copy of Osiris up and running, follow these steps:

Prerequisite Accounts

• ElephantSQL: Link
• AWS S3 Bucket with Amplify: Link

Clone the repository

git clone <repo-url>

Install NPM packages

npm install

Connect Osiris Electron App to SQL Database with ElephantSQL

• Add pgkeys.js to the /src directory.
• Initialize AWS-Amplify to your project.

Install Amplify folder

• Navigate to the Osiris root folder.
• Follow the steps in the Amplify documentation to install Amplify.

Run the Electron app

npm start

Summary

Osiris is a powerful desktop application that simplifies the process of building UI components and pages. With its UI Generator and Library features, users can create custom components in React or Vue and securely store them. The Build Page feature allows for easy manipulation of component hierarchy and customization. Overall, Osiris provides a comprehensive solution for developers and designers to streamline their UI development workflow.