Bunny OS

An OS UX in the common web browser
View Demo · Report Bug · Request Feature

Table of Contents

1. About The Project
   • Built With
2. Getting Started
   • Prerequisites
   • Installation
3. Usage
4. Roadmap
5. Contributing
6. License
7. Contact
8. Acknowledgments

About The Project

The goal of this project is to create an operating system-like environment within the browser, complete with familiar features and built-in applications including a file manager, browser, text editor, terminal, and more. A key part of the motivation for creating BunnyOS was driven by the opportunity to learn and push the boundaries of what is possible with the web APIs built into modern web browsers.

(back to top)

Built With

For fast and enjoyable development the following list of frameworks and libraries was chosen.

• 
• 
• 

(back to top)

Getting Started

To get a local copy up and running follow these simple steps.

Prerequisites

This is an example of how to list things you need to use the software and how to install them.

• npm

  npm install npm@latest -g

Installation

1. Clone the repo

   git clone https://github.com/runeharlyk/Bunny-OS.git

2. Install NPM packages

   npm install

(back to top)

Usage

Developing

Once you've cloned and installed dependencies with npm install (or pnpm install or yarn), start a development server:

npm run dev

# or start the server and open the app in a new browser tab
npm run dev -- --open

Building

To create a production version of your app:

npm run build

(back to top)

Roadmap

• Windowed resizable and draggable apps
• OS process management

See the open issues for a full list of proposed features (and known issues).

(back to top)

Contributing

Contributions are what make the open source community such an amazing place to learn, inspire, and create. Any contributions you make are greatly appreciated.

If you have a suggestion that would make this better, please fork the repo and create a pull request. You can also simply open an issue with the tag "enhancement". Don't forget to give the project a star! Thanks again!

1. Fork the Project
2. Create your Feature Branch (git checkout -b feature/AmazingFeature)
3. Commit your Changes (git commit -m 'Add some AmazingFeature')
4. Push to the Branch (git push origin feature/AmazingFeature)
5. Open a Pull Request

(back to top)

License

Distributed under the MIT License. See LICENSE.txt for more information.

(back to top)