Getting Started

First, install component library in your project directory:

# yarn
$ yarn add @react-os/core

# npm
$ npm install @react-os/core

Set OSProvider in your app with config of your choice... and you are ready to go!

import React from 'react'
import { Frame } from 'react95'
import { React95Provider, OsProvider, OsWindow } from '@react-os/core'

const Notes = ({ data }) => (
  <OsWindow size={[540,480]}>
    <Frame variant="field">
      <p>
        {data.label} is an example of a program!
      </p>
    </Frame>
  </OsWindow>
)

const App = () => (
  <React95Provider>
    <OsProvider
      programs={[
        {
          menu: true,
          desktop: true,
          label: "Notes",
          icon: "address_book_pad",
          component: props => <Notes {...props} />
        },
        // more programs here...
      ]}
    />
  </React95Provider>
)

export default App

Screenshots

Submit your project

Apps built with ReactOS will be featured on the official website.

Contributing

If you want to help with the project, feel free to open pull requests and submit issues or component proposals. Let's bring this UI back to life.