This repository has been archived by the owner on Aug 31, 2024. It is now read-only.
-
Notifications
You must be signed in to change notification settings - Fork 8
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
Showing
1 changed file
with
41 additions
and
40 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,56 +1,57 @@ | ||
| # v5 development ceased on February 20th, 2024. | ||
|
|
||
| # ArcOS Frontend | ||
| <div align="center"> | ||
|
|
||
| <p align="center"> | ||
| <a href="https://izk-arcos.nl/" target="_blank" rel="noopener"> | ||
| <img src="https://github.com/IzK-ArcOS/ArcOS-Frontend/assets/76709090/e1965e53-e96d-41f7-bab5-0061ecd26922" width="768px"/> | ||
| </a> | ||
| </p> | ||
|
|
||
| # 👋 Welcome to ArcOS! | ||
|
|
||
| [](https://madewithsvelte.com/p/arcos/shield-link) | ||
| [](https://discord.gg/S3fTadu88C) | ||
| [](https://discord.gg/S3fTadu88C) | ||
| [](https://github.com/IzK-ArcOS/ArcOS-Frontend/graphs/contributors) | ||
| [](https://github.com/IzK-ArcOS/ArcOS-Frontend/releases) | ||
| [](https://github.com/badges/IzK-ArcOS/ArcOS-Frontend) | ||
|  | ||
|
|
||
| </div> | ||
|
|
||
| Welcome to the frontend for ArcOS! This repository is a rewrite of the original ArcOS project which can be found [here](https://github.com/IzK-ArcOS/ArcOS-Environment) (archived). This project is written in Svelte and Typescript, making it extremely performant and easy to maintain. More information about this project contained [here](https://github.com/IzK-ArcOS?view_as=public). | ||
|
|
||
| > Note: The ArcOS Documentation is currently being worked on by the DWC internal team and might have missing and/or incomplete information. Please be patient. | ||
| ## Getting Started | ||
|
|
||
| To use ArcOS, you can use the current Electron implementation found in the [releases tab](https://github.com/IzK-ArcOS/ArcOS-Frontend/releases/). You can also manually compile the desktop application with **ArcOS Electron Compiler**. All information about building the Electron application is contained on [ArcOS Electron Compiler GitHub repository](https://github.com/IzK-ArcOS/ArcOS-Electron-Compiler) (currently in beta). | ||
| 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](https://github.com/IzK-ArcOS/ArcOS-API-Rewritten) (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 | ||
|
|
||
| You can also use the web frontend, found [here](https://web.izk-arcos.nl/). | ||
| ## 🛠 Getting started | ||
| The easiest way to use ArcOS is to open it on [the web frontend](https://web.izk-arcos.nl/), 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](https://github.com/IzK-ArcOS/ArcOS-Frontend/releases). This Desktop App is powered by Electron, and it might perform better than the browser version, depending on the browser and device. | ||
|
|
||
| If you want to compile the ArcOS frontend from the source, you may do so by following the steps of the [Getting Started](docs/Getting%20Started.md) page in the repository. | ||
| > It is not currently possible to clone the Source Code of ArcOS since ArcOS v6 isn't public as of March 25th, 2024. | ||
| ## Credits & Licensing | ||
| ## Links | ||
|
|
||
| All code in this project was created by me or by other members of the ArcOS Team. All files in this repository are thereby licensed under [GPLv3](./LICENSE). | ||
| These links bring you to the common places in and around ArcOS. | ||
|
|
||
| I want to thank all of these authors for providing their photos, images and other assets for use in ArcOS. Any and all contributions are greatly appreciated. | ||
| - The ArcOS Website lives [here](https://izk-arcos.nl). | ||
| - Our GitHub is [here](https://github.com/IzK-ArcOS) (and amazing). | ||
| - The very code that powers ArcOS is [here](https://github.com/IzK-ArcOS/v6) 🔒. | ||
| - ArcOS runs on our own ArcAPI, which is on [this page](https://github.com/IzK-ArcOS/ArcOS-API-Rewritten). | ||
|
|
||
| | Item | Author | Source | | ||
| | ----------------- | ---------------------------------------------------- | -------------------------------------------------------------------------------- | | ||
| | Icons | Papirus Development Team | [Papirus Icons](https://github.com/PapirusDevelopmentTeam/papirus-icon-theme) | | ||
| | Wallpaper `img08` | SWHFotografie | Wandelbos, Tilburg, the Netherlands | | ||
| | Wallpaper `img18` | SWHFotografie | Wilheminakanaal, Tilburg, the Netherlands | | ||
| | Wallpaper `img13` | SWHFotografie | the Hague, the Netherlands | | ||
| | Wallpaper `img14` | [@keesvv](https://github.com/keesvv) | Scheveningen, the Netherlands | | ||
| | Wallpaper `img15` | [@matteoscaringi](https://github.com/matteoscaringi) | Corfu, Greece | | ||
| | Wallpaper `img17` | [@Blockyheadman](https://github.com/blockyheadman) | Fairfield Bay, US | | ||
| | Wallpaper `img24` | [@NikNikovsky](https://github.com/NikNikovsky) | Radków, PL | | ||
| | Wallpaper `img25` | [@NikNikovsky](https://github.com/NikNikovsky) | Radków, PL | | ||
| | Wallpaper `img26` | [@NikNikovsky](https://github.com/NikNikovsky) | Radków, PL | | ||
| | ArcOS Sounds | @dragonlazer/@calligrafix | Original | | ||
| | Cursors | [@PosyMusic](https://www.youtube.com/@PosyMusic) | [Home > Other > Posy's improved cursors](http://www.michieldb.nl/other/cursors/) | | ||
| ## 💪 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](https://github.com/IzK-ArcOS/ArcOS-Frontend/issues) for feature requests and stuff that needs further discussion. | ||
|
|
||
| All images not listed above are created by or licensed to the ArcOS Team. | ||
| Code contribution to ArcOS isn't currently possible because ArcOS v6 isn't a public repository. | ||
|
|
||
| ## Screenshots | ||
| > [!WARNING] | ||
| > The code you see in [IzK-ArcOS/ArcOS-Frontend](https://github.com/IzK-ArcOS/ArcOS-Frontend) belongs to the now discontinued ArcOS v5. This code is not current anymore, pull requests regarding it will be ignored. | ||
|  | ||
|  | ||
|  | ||
|  | ||
|  | ||
|  | ||
|  | ||
|  | ||
| ## Disclaimers | ||
| - 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. |