README.md

Flow OS

The customizable webOS.
Explore the wiki »

Try it Out · Report Bug · Request Feature

Table of Contents

1. Built With
2. Getting Started
   • Prerequisites
   • Installation
3. Contributing
4. License
5. Contact

Built With

Here are some libraries used to create FlowOS.

• WinBox
• Ultraviolet
• Eruda
• BrowserFS

(back to top)

Getting Started

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

Prerequisites

• yarn

  npm install yarn@latest -g

Installation

1. Clone the repo

   git clone https://github.com/Flow-Works/FlowOS

2. Install packages

   yarn install

3. Run

   yarn start

   or for Windows

   yarn win

(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 (https://github.com/Flow-Works/FlowOS/fork)
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)

🛠️ Contributors

• ThinLiquid (Original developer)
• Proudparrot2 (Ex-developer)
• Darkw4v3 (Current owner, maintainer)

❤️ Special Contributors

• Name=Yug (Bugtester)

License

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

(back to top)

Contact

Join the Discord Server!

(back to top)