https://github.com/imp-dance/radix-os
https://radix-os.netlify.app/
https://github.com/imp-dance/radix-os
Last synced: 2 months ago
JSON representation
https://radix-os.netlify.app/
- Host: GitHub
- URL: https://github.com/imp-dance/radix-os
- Owner: imp-dance
- Created: 2024-09-29T18:03:12.000Z (9 months ago)
- Default Branch: main
- Last Pushed: 2024-10-23T14:22:31.000Z (8 months ago)
- Last Synced: 2024-10-23T16:34:13.531Z (8 months ago)
- Language: TypeScript
- Homepage: https://imp-dance.github.io/radix-os/
- Size: 3.09 MB
- Stars: 1
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# Radix OS
Radix OS is an operating system simulated on the web, with a modular file system that can be swapped out with any async source, able to run your own custom built applications. Designed to be flexible and easily extendable so it can fit your needs.
## Features
- Window management
- Modular file system
- Customizable UI
- App launcher
- Keyboard shortcuts
- Context menus
- System UI components
- Drag 'n drop file upload
## Getting started
### Installation
If you don't have radix ui themes installed already, install this first:
```shell
npm i @radix-ui/themes
```
Then install Radix OS:
```shell
npm i radix-os
```
We also recommend that you install `@radix-ui/react-icons` if you plan on extending the OS with your own applications.
### Quick setup
```tsx
import "@radix-ui/themes/styles.css";
import {
createZustandFsIntegration,
setupApps,
RadixOS,
} from "radix-os";
// You can provide some optional config to these
const fs = createZustandFsIntegration();
const applications = setupApps([]);
export function App() {
return (
);
}
```
### Documentation
To read more about how to create your own applications for the "OS", setting up desktop items and all of the exported utilities - check out [the official docs](https://radix-os.netlify.app/).