54 lines
1.8 KiB
Markdown
54 lines
1.8 KiB
Markdown
<div align="center">
|
|
<img src="https://raw.githubusercontent.com/Flow-Works/FlowOS-2.0/master/src/assets/flow.png" width="100px">
|
|
|
|
# FlowOS
|
|
|
|
<img src="https://cdn.rawgit.com/standard/standard/master/badge.svg" height="50">
|
|
<a href="https://discord.gg/axUqK8CN2n"><img src="https://raw.githubusercontent.com/Flow-Works/FlowOS-2.0/master/src/assets/badge.png" height="50"></a><br/>
|
|
|
|
<img src="https://img.shields.io/github/stars/flow-works/flowos-2.0?style=for-the-badge" />
|
|
<img src="https://img.shields.io/github/issues-pr/flow-works/flowos-2.0?style=for-the-badge" />
|
|
<img src="https://img.shields.io/github/forks/flow-works/flowos-2.0?style=for-the-badge&color=orange" />
|
|
<img src="https://img.shields.io/github/commit-activity/t/Flow-Works/FlowOS-2.0?style=for-the-badge&color=violet" />
|
|
<img src="https://img.shields.io/github/actions/workflow/status/flow-works/flowos-2.0/build.yml?style=for-the-badge" />
|
|
|
|
<br>
|
|
<i>The most aesthetic webOS.</i>
|
|
<br>
|
|
<a href="https://docs.flow-works.me"><strong>Read the docs »</strong></a>
|
|
<br>
|
|
|
|
</div>
|
|
|
|
## What is FlowOS?
|
|
|
|
FlowOS is a web OS proxy made for the Titanium Network 2023 Proxathon. It's extremely customizable with an API to make your apps, themes, and modules.
|
|
|
|
## Getting Started
|
|
|
|
To run FlowOS on your local machine, you need Node.js 16 or above.
|
|
|
|
1. Clone the repository
|
|
```bash
|
|
git clone https://github.com/Flow-Works/FlowOS-2.0
|
|
```
|
|
2. Install packages
|
|
```bash
|
|
npm install
|
|
```
|
|
3. Run!
|
|
```bash
|
|
npm run serve
|
|
```
|
|
## Contributing
|
|
|
|
|
|
## Made with
|
|
FlowOS is made with the following software:
|
|
* [Filer](https://github.com/filerjs/filer)
|
|
* [Prism Code Editor](https://github.com/FIameCaster/prism-code-editor)
|
|
* [Vite](https://vitejs.dev)
|
|
* [Ultraviolet](https://github.com/titaniumnetwork-dev/ultraviolet)
|
|
|
|
## License
|
|
FlowOS is licensed under the MIT license. See the `LICENSE` file for more information.
|