mirrors/puter
1
0
Fork 0
mirror of https://github.com/HeyPuter/puter synced 2024-11-14 22:06:00 +00:00
Code Issues Packages Projects Releases Wiki Activity
183 Commits 21 Branches 9 Tags 28 MiB
JavaScript 95.2%
CSS 2.7%
HTML 1.6%
Shell 0.2%
Dockerfile 0.2%
5f18032737
Go to file
Sam Atkins 5f18032737 Migrate to JavaScript modules
2024-03-20 14:10:39 +00:00
.github/workflows Change branch name in comment too. 2024-03-15 10:51:12 +01:00
docs Initial commit 2024-03-02 18:39:14 -08:00
incubator/x86emu Add checklists for x86 emulation project 2024-03-14 14:15:10 -04:00
src Migrate to JavaScript modules 2024-03-20 14:10:39 +00:00
.dockerignore Update Dockerfile 2024-03-06 14:06:58 -05:00
.env.example Implement .env support for PORT property 2024-03-12 22:42:13 -07:00
.gitattributes Initial commit 2024-03-02 18:39:14 -08:00
.gitignore Implement .env support for PORT property 2024-03-12 22:42:13 -07:00
build.js Migrate to JavaScript modules 2024-03-20 14:10:39 +00:00
CONTRIBUTING.md Use the correct link for good first issue 2024-03-11 14:16:12 -07:00
dev-server.js Migrate to JavaScript modules 2024-03-20 14:10:39 +00:00
docker-compose.yml add dockerfiles 2024-03-06 03:15:23 +01:00
Dockerfile Update Dockerfile 2024-03-06 14:06:58 -05:00
LICENSE.txt Initial commit 2024-03-02 18:39:14 -08:00
package-lock.json Implement .env support for PORT property 2024-03-12 22:42:13 -07:00
package.json Migrate to JavaScript modules 2024-03-20 14:10:39 +00:00
README.md Update tagline in README.md 2024-03-13 17:25:54 -07:00
SECURITY-ACKNOWLEDGEMENTS.md Update SECURITY-ACKNOWLEDGEMENTS.md to add Tim's GitHub 2024-03-13 18:55:14 -07:00
SECURITY.md Create SECURITY.md 2024-03-13 16:33:03 -07:00
utils.js Migrate to JavaScript modules 2024-03-20 14:10:39 +00:00

README.md

Puter.com, The Personal Cloud Computer: All your files, apps, and games in one place accessible from anywhere at any time.

The Internet OS, Free and Open-Source!

« LIVE DEMO »

Puter.com · SDK · Discord · Reddit · X (Twitter)

screenshot


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.


Getting Started

Local Development

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).


Using Docker

git clone https://github.com/HeyPuter/puter
cd puter
docker compose up

Deploy to Production

Detailed guide on how to deploy Puter in production: docs/prod.md


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!

❓ 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, Photopea, and OnlyOffice.


❓ 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.


Credits

The default wallpaper is created by Milad Fakurian and published on Unsplash.

Icons by Papirus under GPL-3.0 license.

Icons by Iconoir under MIT license.

Icons by Elementary Icons under GPL-3.0 license.

Icons by Tabler Icons under MIT license.

Icons by bootstrap-icons under MIT license.