mirror of
https://github.com/HeyPuter/puter
synced 2024-11-14 22:06:00 +00:00
102 lines
3.3 KiB
Markdown
102 lines
3.3 KiB
Markdown
<h3 align="center"><img width="80" alt="Puter.com, The Personal Cloud Computer: All your files, apps, and games in one place accessible from anywhere at any time." src="https://assets.puter.site/puter-logo.png"></h3>
|
|
|
|
<h3 align="center">Internet OS and Desktop Environment in the Browser!</h3>
|
|
|
|
<p align="center">
|
|
<a href="https://puter.com/"><strong>« LIVE DEMO »</strong></a>
|
|
<br />
|
|
<br />
|
|
<a href="https://puter.com">Puter.com</a>
|
|
·
|
|
<a href="https://docs.puter.com" target="_blank">SDK</a>
|
|
·
|
|
<a href="https://discord.com/invite/PQcx7Teh8u">Discord</a>
|
|
·
|
|
<a href="https://reddit.com/r/puter">Reddit</a>
|
|
·
|
|
<a href="https://twitter.com/HeyPuter">X (Twitter)</a>
|
|
</p>
|
|
|
|
<h3 align="center"><img width="700" style="border-radius:5px;" alt="screenshot" src="https://assets.puter.site/puter.com-screenshot-2.webp"></h3>
|
|
|
|
<br/>
|
|
|
|
## Puter
|
|
|
|
Puter is an advanced open-source desktop environment in the browser, designed to be feature-rich, exceptionally fast, and highly extensible. It can be used to build remote desktop environments or serve as an interface for cloud storage services, remote servers, web hosting platforms, and more.
|
|
|
|
<br/>
|
|
|
|
## Getting Started
|
|
|
|
### Local Development
|
|
|
|
```bash
|
|
git clone https://github.com/HeyPuter/puter
|
|
cd puter
|
|
npm install
|
|
npm start
|
|
```
|
|
|
|
This will launch Puter at http://localhost:4000 (or the next available port).
|
|
|
|
<br/>
|
|
|
|
### Using Docker
|
|
|
|
```bash
|
|
git clone https://github.com/HeyPuter/puter
|
|
cd puter
|
|
docker compose up
|
|
```
|
|
|
|
<br/>
|
|
|
|
## Deploy to Production
|
|
|
|
Detailed guide on how to deploy Puter in production: [docs/prod.md](docs/prod.md)
|
|
|
|
<br/>
|
|
|
|
## FAQ
|
|
|
|
### ❓ What's the use case for Puter?
|
|
|
|
Puter can be used as:
|
|
|
|
- An alternative to Dropbox, Google Drive, OneDrive, etc. with a fresh interface and powerful features.
|
|
- Remote desktop environment for servers and workstations.
|
|
- A platform for building and hosting websites, web apps, and games.
|
|
- A friendly, open-source project and community to learn about web development, cloud computing, distributed systems, and much more!
|
|
|
|
<br/>
|
|
|
|
|
|
### ❓ Why isn't Puter built with React, Angular, Vue, etc.?
|
|
|
|
For performance reasons, Puter is built with vanilla JavaScript and jQuery. Additionally, we'd like to avoid complex abstractions and to remain in control of the entire stack, as much as possible.
|
|
|
|
Also partly inspired by some of our favorite projects that are not built with frameworks: [VSCode](https://github.com/microsoft/vscode), [Photopea](https://www.photopea.com/), and [OnlyOffice](https://www.onlyoffice.com/).
|
|
|
|
<br/>
|
|
|
|
### ❓ Why jQuery?
|
|
|
|
Puter interacts directly with the DOM and jQuery provides an elegant yet powerful API to manipulate the DOM, handle events, and much more. It's also fast, mature, and battle-tested.
|
|
|
|
<br/>
|
|
|
|
## Credits
|
|
|
|
The default wallpaper is created by [Milad Fakurian](https://unsplash.com/photos/blue-orange-and-yellow-wallpaper-E8Ufcyxz514) and published on [Unsplash](https://unsplash.com/).
|
|
|
|
Icons by [Papirus](https://github.com/PapirusDevelopmentTeam/papirus-icon-theme) under GPL-3.0 license.
|
|
|
|
Icons by [Iconoir](https://iconoir.com/) under MIT license.
|
|
|
|
Icons by [Elementary Icons](https://github.com/elementary/icons) under GPL-3.0 license.
|
|
|
|
Icons by [Tabler Icons](https://tabler.io/) under MIT license.
|
|
|
|
Icons by [bootstrap-icons](https://icons.getbootstrap.com/) under MIT license.
|