zOS

Flexible application platform for interacting with the Zer0 ecosystem

Getting Started

1. clone the repo
2. run npm install
3. copy .env.example to .env and change/add the necessary values
4. run npm start to run the app or
5. npm run test to run the tests

Ways to Participate

Create an app

The zOS Feed app is the first core app, and provides a template to follow. Get in touch with the zOS core team to discuss having your app integrated.

1. fork the zOS repo, as new apps still require some changes to the platform at this stage.
2. follow the getting started steps above and make sure you have a running zOS instance.
3. add a repo for your new app. you can copy the feed app to get the basics, or just start from scratch.
4. an app is just a component that conforms to the interface required by the platform. once you have the basics of your app in place, you can add it to the platform to make sure it loads correctly:
   1. add your package, and import in src/app-sandbox/index.tsx
   2. add a conditional to the renderSelectedApp method that returns your component. if your app is covered by the default apps set, then use the corresponding member of the Apps enum.
   3. add your app to the allApps array in src/lib/apps/index.ts
   4. make sure your app shows up in the menu, and that you can access it when the menu item is clicked.
   5. once you have a stable version of your app, you can create a PR to the core zOS repo with the platform changes, and the version of your app you would like released.

Contribute to the Platform

There is always work to be done on the core platform, so if you've noticed a bug or want to get involved at a deeper level, feel free to open a PR, or get in touch with the core team. Be sure to check out the contributing guidelines and style guide before opening a PR.

Architecture

A high level overview of the Component, Connected Component, Redux Saga, Normalizr, Redux architecture: https://miro.com/app/board/uXjVPL_sxFI=/

Deployment

Production

1. Increment the version number in the package.json file and update the package-lock.json (npm install --package-lock-only)
2. Create a PR and merge your version update
3. View https://github.com/zer0-os/zOS/releases, find your new release and edit it, ensure that Set as the latest release is checked, and click the Publish Release button
4. View https://github.com/zer0-os/zOS/actions, watch for your release deployment to complete
5. View https://zos.zer0.io, open the Developer Tools Console, verify that your version number is correct (matches your version increment in package.json from the first step)

Matrix

For local development you can test against the development home server or run our matrix server locally: https://github.com/zer0-os/zOS-chat-server. If you want to run against your local home server set the env var and restart zOS: REACT_APP_MATRIX_HOME_SERVER_URL=http://localhost:8008