46 lines
No EOL
1.5 KiB
Markdown
46 lines
No EOL
1.5 KiB
Markdown
<div align="center">
|
|
<img src="https://raw.githubusercontent.com/Flow-Works/FlowOS/main/public/assets/logo.svg" width="100px">
|
|
<p style="font-size: 28px; font-weight: bold">Flow OS</p>
|
|
<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" />
|
|
<br><br>
|
|
<i>The next generation of Flow OS</i>
|
|
<br>
|
|
<a href="https://docs.flow-works.me"><strong>Read the docs »</strong></a>
|
|
<hr>
|
|
|
|
</div>
|
|
|
|
## What is Flow OS?
|
|
Flow OS is a web OS proxy made for the Titanium Network 2023 Proxathon. It's extremly customizable with an API to make your own apps, themes, and modules.
|
|
|
|
## Getting Started
|
|
To run Flow OS on your local machine, you need Node.js 16 or above.
|
|
* Clone the repository
|
|
```
|
|
git clone https://github.com/flow-works/flowos
|
|
```
|
|
* Install packages
|
|
```
|
|
npm install
|
|
```
|
|
* Build and run!
|
|
```
|
|
npm run build
|
|
npm run serve
|
|
```
|
|
|
|
## Made with
|
|
Flow OS is made with the following software:
|
|
* [Filer](https://github.com/filerjs/filer)
|
|
* [PrismJS](https://github.com/PrismJS/prism)
|
|
* [Vite](https://vitejs.dev)
|
|
* [Ultraviolet](https://github.com/titaniumnetwork-dev/ultraviolet)
|
|
|
|
## License
|
|
Flow OS is licensed under the MIT license. See the `LICENSE` file for more information. |