{"id":26267648,"url":"https://github.com/oslabs-beta/osiris","last_synced_at":"2025-04-30T19:09:20.678Z","repository":{"id":56554394,"uuid":"278881440","full_name":"oslabs-beta/Osiris","owner":"oslabs-beta","description":"An Electron based desktop application for generating components, building pages, and storing them in a UI library. ","archived":false,"fork":false,"pushed_at":"2020-10-31T21:48:31.000Z","size":1689,"stargazers_count":177,"open_issues_count":0,"forks_count":7,"subscribers_count":6,"default_branch":"master","last_synced_at":"2025-04-30T19:09:07.652Z","etag":null,"topics":["electron","js","libary","react","ui","ui-components","ux","ux-design","vue"],"latest_commit_sha":null,"homepage":"","language":"JavaScript","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/oslabs-beta.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":"code-of-conduct.md","threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null}},"created_at":"2020-07-11T14:47:56.000Z","updated_at":"2023-10-28T11:00:48.000Z","dependencies_parsed_at":"2022-08-15T20:50:38.018Z","dependency_job_id":null,"html_url":"https://github.com/oslabs-beta/Osiris","commit_stats":null,"previous_names":[],"tags_count":0,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/oslabs-beta%2FOsiris","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/oslabs-beta%2FOsiris/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/oslabs-beta%2FOsiris/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/oslabs-beta%2FOsiris/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/oslabs-beta","download_url":"https://codeload.github.com/oslabs-beta/Osiris/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":251767186,"owners_count":21640469,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["electron","js","libary","react","ui","ui-components","ux","ux-design","vue"],"created_at":"2025-03-14T04:17:39.329Z","updated_at":"2025-04-30T19:09:20.652Z","avatar_url":"https://github.com/oslabs-beta.png","language":"JavaScript","funding_links":[],"categories":[],"sub_categories":[],"readme":"\u003c!-- PROJECT SHIELDS --\u003e\n\u003c!--\n*** I'm using markdown \"reference style\" links for readability.\n*** Reference links are enclosed in brackets [ ] instead of parentheses ( ).\n*** See the bottom of this document for the declaration of the reference variables\n*** for contributors-url, forks-url, etc. This is an optional, concise syntax you may use.\n*** https://www.markdownguide.org/basic-syntax/#reference-style-links\n--\u003e\n\u003c!-- PROJECT LOGO --\u003e\n\u003cbr /\u003e\n\u003cp align=\"center\"\u003e\n  \u003ca href=\"https://github.com/oslabs-beta/Osiris/\"\u003e\n    \u003cimg src=\"https://i.ibb.co/pyyR40z/Final-Osiris.jpg\" alt=\"Logo\"\u003e\n  \u003c/a\u003e\n\n## Osiris\nAn Electron based desktop application for generating components and storing them in a UI library.\n\n  __________\n\n\n\u003c!-- TABLE OF CONTENTS --\u003e\n## Table of Contents\n\n* [About the Project](#about-the-project)\n  * [Built With](#built-with)\n* [Usage](#usage)\n* [Getting Started](#getting-started)\n  * [Prerequisites](#prerequisites)\n  * [Installation](#installation)\n* [Contributing](#contributing)\n* [Contact](#contact)\n* [Authors](#authors)\n* [License](#license)\n\n\n\n\u003c!-- ABOUT THE PROJECT --\u003e\n## About The Project\n\nOsiris 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.\n\n### Built With\n* [Electron](https://www.electronjs.org/)\n* [React](https://reactjs.org/)\n* [PostgreSQL](https://www.postgresql.org/)\n* [Node](https://nodejs.org/en/)\n* [Webpack](https://webpack.js.org/)\n* [AWS](https://aws.amazon.com/)\n\n\u003c!-- USAGE EXAMPLES --\u003e\n## Usage\n\n_______\n\n\n**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\n\n\u003cimg src=\"https://i.ibb.co/6vTMGSC/generator1.gif\"\u003e\n\n_______\n\n\n**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\n\n\u003cimg src=\"https://i.ibb.co/PzPfFT5/buildpage1.gif\"\u003e\n\n________\n\n\n**Build Page: Hierarchy \u0026 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!\n\n\u003cimg src=\"https://iili.io/d1XamG.gif\" alt=\"buildpage2\"\u003e\n\n_______\n\n\n\u003c!-- GETTING STARTED --\u003e\n## Getting Started\n\nTo get a local copy up and running follow these steps.\n\n### Prerequisite Accounts\n\n* ElephantSQL:\nhttps://www.elephantsql.com/\n\n* AWS S3 Bucket with Amplify: \nhttps://docs.amplify.aws/lib/storage/getting-started/q/platform/js\n\n### Installation\n\n1. Clone the repo\n```sh\ngit clone https://github.com/oslabs-beta/Osiris.git\n```\n2. Install NPM packages\n```sh\nnpm install\n```\n### Connect Osiris Electron App to SQL Database with ElephantSQL \n\n1. SQL Script\n```sh\nCREATE TABLE individual_ui (id SERIAL PRIMARY KEY, organization_id VARCHAR, image VARCHAR, tags VARCHAR, react_code VARCHAR, file_name VARCHAR, type VARCHAR, description VARCHAR);\n```\n\n2. Add pgkeys.js to /src and include the following:\n```sh\nexport const PG_URI = '\u003cyour ElephantSQL uri\u003e'\n```\n### Initialize AWS-Amplify to your project \n\n1. Navigate to Osiris Root folder\n\n2. Install Amplify folder following these steps:\n\nhttps://docs.amplify.aws/start/getting-started/installation/q/integration/react\nhttps://docs.amplify.aws/lib/storage/getting-started/q/platform/android#initialize-amplify-storage\n\n### Run\n\n1. Run the electron app\n```sh\nnpm start\n```\n\n\n\u003c!-- CONTRIBUTING --\u003e\n### Contributing\n\nContributions are what make the open source community such an amazing place to be, learn, inspire, and create. Any contributions you make are **greatly appreciated**.\n\n1. Fork the Project\n2. Create your Feature Branch (`git checkout -b feature/AmazingFeature`)\n3. Commit your Changes (`git commit -m 'Add some AmazingFeature'`)\n4. Push to the Branch (`git push origin feature/AmazingFeature`)\n5. Open a Pull Request\n\n\n\u003c!-- CONTACT --\u003e\n## Contact\n\nWebsite: [https://osirisdev.io](https://osirisdev.io/)\n\nGithub Link: [https://github.com/oslabs-beta/Osiris/](https://github.com/oslabs-beta/Osiris/)\n\nTwitter: [@osiris_io](https://twitter.com/osiris_io)\n \n\u003c!--- Authors ---\u003e\n## Authors\n\n* [@Wayne Wilcox](https://github.com/LovelaceDink)\n* [@Eelan Tung](https://github.com/cupofjoy)\n* [@Cameron Fitz](https://github.com/cameronleefitz)\n* [@Jehovany Cruz](https://github.com/howaboutjeho)\n* [@Garrett Lee](https://github.com/geewailee)\n\n\u003c!-- LICENSE --\u003e\n## License\n\nDistributed under the MIT License. See `LICENSE` for more information.\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Foslabs-beta%2Fosiris","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Foslabs-beta%2Fosiris","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Foslabs-beta%2Fosiris/lists"}