Merge pull request #62 from try-supernova/develop

Author: 443pablo

.env.example

@@ -0,0 +1,5 @@
+NODE_ENV=development
+GLOBAL_ROOT=pluto-40t.pages.dev
+DEV_SERVER_PORT=3000
+PACKAGE_MANAGER=yarn # npm is not supported
+DEV_INSTALLER_PERSISTENT=false

.github/workflows/tauri.yml

@@ -0,0 +1,42 @@
+name: 'publish'
+on:
+  push:
+    branches:
+      - RELEASE
+      - staging
+
+jobs:
+  publish-tauri:
+    permissions:
+      contents: write
+    strategy:
+      fail-fast: false
+      matrix:
+        platform: [macos-latest, ubuntu-20.04, windows-latest]
+
+    runs-on: ${{ matrix.platform }}
+    steps:
+      - uses: actions/checkout@v3
+      - name: setup node
+        uses: actions/setup-node@v3
+        with:
+          node-version: 16
+      - name: install Rust stable
+        uses: dtolnay/rust-toolchain@stable
+      - name: install dependencies (ubuntu only)
+        if: matrix.platform == 'ubuntu-20.04'
+        run: |
+          sudo apt-get update
+          sudo apt-get install -y libgtk-3-dev libwebkit2gtk-4.0-dev libappindicator3-dev librsvg2-dev patchelf
+      - name: install frontend dependencies
+        run: yarn install # change this to npm or pnpm depending on which one you use
+      - uses: tauri-apps/tauri-action@v0
+        env:
+          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
+          PRERELEASE: ${{ startsWith(github.ref, 'refs/heads/staging') }}
+        with:
+          tagName: app-v__VERSION__ # the action automatically replaces \_\_VERSION\_\_ with the app version
+          releaseName: 'Pluto Desktop v__VERSION__'
+          releaseBody: 'See the assets to download this version and install.'
+          releaseDraft: true
+          prerelease: ${{ env.PRERELEASE }}

.gitignore

@@ -1,10 +1,17 @@
-# temporary folders that get zipped... @TODO remove these folders after they get zipped
+# temporary folders that get deleted after build but if build fails they are still there
 target_fs_BUILD/
 installer_fs_BUILD/
 
+target_fs/Pluto/System41/**/dist/*
+installer_fs/Pluto/System41/**/dist/*
+.turbo
+
 .vscode
 out
 .idea
+dist
+temp/
+tmp/
 
 # Logs
 logs
@@ -88,7 +95,6 @@ typings/
 
 # Nuxt.js build / generate output
 .nuxt
-dist
 
 # Gatsby files
 .cache/

.husky/commit-msg

@@ -1,4 +1,4 @@
 #!/usr/bin/env sh
 . "$(dirname -- "$0")/_/husky.sh"
 
-npx --no -- commitlint --edit ${1}
+npx --no -- commitlint --edit "${1}"

.tool-versions

@@ -0,0 +1 @@
+nodejs 18.20.8

CODE_OF_CONDUCT.md

@@ -1 +1 @@
-(c) Copyright 2023 stretch07, All rights reserved.
+(c) Copyright 2025 Pablo Gracia, All rights reserved.

LICENSE.md

@@ -1,14 +1,43 @@
-# 🌌 pluto
+# 🌌 supernova
 a complete web OS
+> **Note:** Along with all the source code, this document is closed-source and private. If you find this document floating around the internet or if someone sends it to you, [contact me](https://pablogracia.net/contact).
 ## About
-Pluto is a close-sourced Web OS, similar to Windows93 or Windows96. It intends to be the most sophisticated, complete, and developer-friendly web OS.  
-Applications in open99 run under the 41worker environment, which is comparable to WRT for Windows 96. 41worker applications run in workers to improve speed, security, and convenience. To learn more, visit [the docs page](https://developers.pluto.stretch.wtf/learn/api/41worker).
+Supernova is an offline, close-sourced Web OS, similar to Windows93 or Windows96. It intends to be the most sophisticated, complete, and developer-friendly web OS.  
+Supernova programs run under the program runtime (codename 41worker), which is comparable to WRT for Windows 96. These applications run in workers to improve speed, security, and convenience. To learn more, visit [the docs page](https://learn.d.pluto.pablogracia.net/api/41worker).
+## Installation
+> Make sure you have yarn installed. Supernova does not support npm/pnpm.
+1. Clone the repository locally.
+2. Copy the environment variables by running `cp .env.example .env`.
+3. Install the dependencies by running `yarn`.
+### Tauri Installation
+Supernova uses the Tauri framework to build the desktop application.
+This is not required for the web version.  
+> Follow the instructions [here](https://tauri.app/v1/guides/getting-started/prerequisites) to install the required tools for building for desktop.
 ## Usage
-You can build pluto by running `npm run build`. This will build the OS and put it in the `/dist` folder.
+You can build Supernova by running `yarn build`.
+This will build the OS into the `/dist` folder.
+Because Supernova is a static application, it does not require any server-side shenanigans.  
+Additionally, you may use `yarn start` to build and serve Supernova locally on port 8000.
+This enables the watch mode, meaning every time you save a file, the application will rebuild.
+
+To build Supernova on the global network, Cloudflare Pages, you must push to the RELEASE branch.
+
+### Build Mode
+Supernova requires for a build mode environment variable to be set. Currently, this can either be in `development` or `production` modes.
+This is declared using the NODE_ENV environment variable (yes, capitalized).
+
+Certain parts of the Supernova kernel rely on NODE_ENV (for example, anti-piracy, devtools detector, obfuscation, etc.).
+Code that references `process.env.NODE_ENV` is simplified at build, for both development and production modes.
+
 ## Structure
-`/installer_fs` gets built into `/public/assets/installer.zip` as a zip file.  
-`/target_fs` gets built into `/public/assets/rootfs.zip` as a zip file.  
-`/build` is the build scripts.  
-`/public` is static files. This includes CSS as well as images.  
-`/src` is the OS kernel and gets built to `/dist/index.js`.  
-`/dist` is your ready-to-run build of Pluto.  
+### Directories
+* `/executables/installer/` gets built into `/dist/assets/installer.zip` as a zip file.
+* `/executables/root/` gets built into `/dist/assets/rootfs.zip` as a zip file.
+* `/scripts/` is the build scripts.  
+* `/public/` is static files. This includes CSS as well as images.  
+* `/src/` is the OS kernel and gets built to `/dist/index.js`.  
+* `/src-tauri/` is the Tauri application code (contains rust and tauri config, mainly)  
+* `/dist/` is your ready-to-run build of Supernova.  
+
+## CLOC
+You may accurately count lines of code by running `cloc --exclude-dir="node_modules,src-tauri,dist,package-lock.json" --quiet .` in the root directory.