Skip to content
This repository has been archived by the owner on Aug 31, 2024. It is now read-only.

IzK-ArcOS/v6

👋 Welcome to ArcOS!

MadeWithSvelte.com Chat with us! Contributors Releases Pulse Uptime

ArcOS is the advanced Svelte-based Operating System Environment in your browser. With ArcOS we aim to create the best possible experience we can within the confines of your browser. ArcOS consists of:

  • 📊 Advanced process and service management,
  • ☁ Readymade cloud storage to access your account from anywhere using ArcOS' ArcAPI (WIP),
  • 🔐 A secure user system consisting of hashed and salted passwords,
  • 🗄 Filesystem integration to store, create and upload files,
  • 📧 A built-in messaging system to talk to other ArcOS users on the same server,
  • ✨ Endless customization options to really adjust ArcOS to your personal taste,
  • 🐣 Beginner-friendly User Interface without the need of manuals,
  • 🧾 Inclusive Help & Support center to read up on things you don't immediately understand,
  • ⚠ Powerful error reporting and crash logs so that we can fix anything that's wrong as fast as possible

🛠 Getting started

The easiest way to use ArcOS is to open it on the web frontend, which is always updated to match the current version of ArcOS. If you prefer a download instead, you can find the latest updates on the releases page. This Desktop App is powered by Electron, and it might perform better than the browser version, depending on the browser and device.

The other option: cloning ArcOS yourself.

Cloning ArcOS v6 is now possible! As of June 25th 2024, ArcOS v6 is made public. Though, because of the scale of this project, it isn't as straight-forward to clone as its predecessor.

Prerequisites

You'll need these dependencies installed on your system to be able to clone and run ArcOS v6:

  • Git (download)
  • NodeJS 20+ (download)
  • Yarn: npm i -g yarn
  • Serve: npm i -g serve

To clone ArcOS v6:

  • Use git with --recurse-submodules to clone ArcOS with all submodules included:
    $ git clone --recurse-submodules https://github.com/IzK-ArcOS/v6
  • Go into the v6 directory and install the dependencies:
    $ cd v6
    $ yarn
  • To run ArcOS v6, you can run yarn serve to start a built version of ArcOS. You can access it on https://localhost:3000/.
  • To work on ArcOS, you can run yarn dev to start the development environment. The development environment will start on https://localhost:5173/.

Note: because of the way yarn build is set up, you can't use the --outDir flag. Sorry about that.

To update your local copy of v6:

Because of the way ArcOS is configured, please do not use git pull on its own. Instead, use the yarn update command we provide to automatically pull all upstream changes as well as update all submodules ArcOS has.

Links

These links bring you to the common places in and around ArcOS.

  • The ArcOS Website lives here.
  • ArcOS can be used on this site (beta)
  • Our GitHub is here (and amazing).
  • ArcOS runs on our own ArcAPI, which is on this page.

💪 Contributing

Found something you miss or is there a bug that we need to resolve? The best place for bugs is Bug Reports inside ArcOS, and the issues page for feature requests and stuff that needs further discussion.

You can also contribute code! If you're working in a submodule, please make sure the branch is set to the submodule's main branch to avoid unknown refs. The team does this using the branch button next to the submodule in Visual Studio Code's source control tab.

Warning

The code you see in IzK-ArcOS/ArcOS-Frontend belongs to the now discontinued ArcOS v5. This code is not current anymore, pull requests regarding it will be ignored.

Disclaimersz`

  • ArcOS cannot be used as a primary operating system. An attempt to do so is discouraged.
  • This is not an actual operating system. It is an environment that runs on top of your already existing OS, built using web technologies. It isn't possible to install already existing applications from third parties. This functionality may be implemented in the distant future.
  • All assets in ArcOS, including those created by the team, belong to their respective owners. Reuse without credit is not permitted.
  • The ArcOS team is not responsible for loss of data when using ArcAPI. Do not store sensitive info on the File System. ArcAPI passwords are hashed and salted.