Release backend

Author: KernelDeimos

.is_puter_repository

@@ -51,6 +51,12 @@ We maintain a list of issues that are good for first-time contributors. You can
 
 <br>
 
+## Documentation for Contributors
+
+See [doc/contributors/index.md](./doc/contributors/index.md) for more information.
+
+<br>
+
 ## Code Review
 
 Once you've submitted your pull request, the project maintainers will review your changes. We may suggest some changes or improvements. This is a normal part of the process, and your contributions are greatly appreciated!

CONTRIBUTING.md

@@ -52,9 +52,8 @@ docker compose up
 
 <br/>
 
-## Deploy to Production
-
-Detailed guide on how to deploy Puter in production: [docs/prod.md](docs/prod.md)
+## ⚠️ Self-Hosting ⚠️
+The self-hosted version of Puter is currently in alpha stage and should not be used in production yet. It is under active development and may contain bugs, other issues. Please exercise caution and use it for testing and evaluation purposes only.
 
 <br/>
 

README.md

@@ -0,0 +1,25 @@
+# Contributing to Puter
+
+## Essential / General Knowledge
+
+### Repository Dichotomy
+
+- Puter's GUI is at the root; `/src` is the GUI
+- Puter's backend is a workspace npm package;
+  it resides in `packages/backend(/src)`
+
+The above may seem counter-intuitive; backend and frontend are siblings, right?
+Consider this: by a different intuition, the backend is at a "deeper" level
+of function; this directory structure better adheres to soon-to-be contributors
+sifting around through the files to discover "what's what".
+
+The directory `volatile` exists _for your convenience_ to simplify running
+Puter for development. When Puter is run
+run with the backend with this repository as its working directory, it
+will use `volatile/config` and `volatile/runtime` instead of
+`/etc/puter` and `/var/puter`.
+
+## See Next
+
+- [Backend Documentation](../../packages/backend/doc/contributors/index.md)
+<!-- - [Frontend Documentation](./frontend.md) -->

doc/contributors/index.md

@@ -0,0 +1,16 @@
+Copyright (C) 2024 Puter Technologies Inc.
+
+This file is part of Puter.
+
+Puter is free software: you can redistribute it and/or modify
+it under the terms of the GNU Affero General Public License as published
+by the Free Software Foundation, either version 3 of the License, or
+(at your option) any later version.
+
+This program is distributed in the hope that it will be useful,
+but WITHOUT ANY WARRANTY; without even the implied warranty of
+MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+GNU Affero General Public License for more details.
+
+You should have received a copy of the GNU Affero General Public License
+along with this program.  If not, see <https://www.gnu.org/licenses/>.

doc/license_header.txt

@@ -0,0 +1,2 @@
+import backend from '@heyputer/backend';
+export default backend;

docs/prod.md doc/prod.md

@@ -0,0 +1,26 @@
+{
+    "ignore": ["**/!(*.js|*.css)", "**/assets/**"],
+    "license": "doc/license_header.txt",
+    "licenseFormats": {
+        "js": {
+            "prepend": "/*",
+            "append": " */",
+            "eachLine": {
+                "prepend": " * "
+            }
+        },
+        "dotfile|^Dockerfile": {
+            "eachLine": {
+                "prepend": "# "
+            }
+        },
+        "css": {
+            "prepend": "/*",
+            "append": " */",
+            "eachLine": {
+                "prepend": " * "
+            }
+        }
+    },
+    "trailingWhitespace": "TRIM"
+}