Merge Jank Client Changes

.github/ISSUE_TEMPLATE/bug_report.md

@@ -0,0 +1,38 @@
+---
+name: Bug report
+about: Create a report to help us improve.
+title: ''
+labels: ''
+assignees: ''
+
+---
+
+**Describe the bug**
+A clear and concise description of what the bug is.
+
+**To Reproduce**
+Steps to reproduce the behavior:
+1. Go to '...'
+2. Click on '....'
+3. Scroll down to '....'
+4. See error
+
+**Expected behavior**
+A clear and concise description of what you expected to happen.
+
+**Screenshots**
+If applicable, add screenshots to help explain your problem.
+
+**Desktop (please complete the following information):**
+ - OS: [e.g. iOS]
+ - Browser: [e.g. Chrome, Safari]
+ - Browser Version: [e.g. 22]
+
+**Smartphone (please complete the following information):**
+ - Device: [e.g. iPhone6]
+ - OS: [e.g. iOS8.1, Android 16]
+ - Browser: [e.g. stock browser, safari]
+ - Browser Version: [e.g. 22]
+
+**Additional context**
+Add any other context about the problem here.

.github/ISSUE_TEMPLATE/feature_request.md

@@ -0,0 +1,20 @@
+---
+name: Feature request
+about: Suggest an idea for this project.
+title: ''
+labels: ''
+assignees: ''
+
+---
+
+**Is your feature request related to a problem? Please describe.**
+A clear and concise description of what the problem is. Example: I'm always frustrated when [...]
+
+**Describe the solution you'd like**
+A clear and concise description of what you want to happen.
+
+**Describe alternatives you've considered**
+A clear and concise description of any alternative solutions or features you've considered.
+
+**Additional context**
+Add any other context or screenshots about the feature request here.

.github/pull_request_template.md

@@ -0,0 +1,5 @@
+# Description
+A description of the pull request.
+
+# Related issues
+Any related issues, delete if there are none.

.github/workflows/docker-image.yml

@@ -0,0 +1,18 @@
+name: Docker Image CI
+
+on:
+  push:
+    branches: [ "main" ]
+  pull_request:
+    branches: [ "main" ]
+
+jobs:
+
+  build:
+
+    runs-on: ubuntu-latest
+
+    steps:
+    - uses: actions/checkout@v4
+    - name: Build the Docker image
+      run: docker build . --file Dockerfile --tag my-image-name:$(date +%s)

.github/workflows/tsc-check.yml

@@ -0,0 +1,20 @@
+name: TSC check CI
+
+on:
+  push:
+  pull_request:
+
+jobs:
+  tsc:
+    name: tsc
+    runs-on: ubuntu-latest
+    steps:
+    - uses: actions/checkout@v1
+    - name: install node v22
+      uses: actions/setup-node@v1
+      with:
+        node-version: 22
+    - name: npm i
+      run: npm i
+    - name: tsc
+      run: tsc --noEmit

.gitignore

@@ -137,3 +137,6 @@ uptime.json
 .dist/
 bun.lockb
 src/webpage/translations/langs.js
+
+build.js
+dependency-graph.svg

.swcrc

@@ -0,0 +1,13 @@
+{
+	"$schema": "https://swc.rs/schema.json",
+	"jsc": {
+		"parser": {
+			"syntax": "typescript",
+			"tsx": false
+		},
+
+		"target": "es2024"
+	},
+	"sourceMaps": true,
+	"minify": true
+}

CODE_OF_CONDUCT.md

@@ -0,0 +1,5 @@
+# Code of conduct
+It's nothing complicated, I want to foster a nice community, if there's any issues feel free to contact me in any way you see fit, though please don't create problems for me. I'm just one person and I want to work on this project, not community management. I will likely start with a warning or two if any issues arise, though this is up to my (mathium05) sole discretion.
+Generally follow https://docs.spacebar.chat/contributing/conduct/ and you should be fine. Do not try to pull technicalities, this is a FOSS project, not a court of law.
+
+Happy coding!

CONTRIBUTING.md

@@ -0,0 +1 @@
+This ain't exactly rocket science, please just describe what you've done, and follow all normal steps, it may take a few days for me to get back to you, life happens. Just try to keep the pull requests fairly small, so adding one thing or fixing one thing, but you may fix multiple bugs in one patch if they're either related or small enough. These are all soft rules and I am going to be more lenient. 

CompressingImages.md

@@ -2,31 +2,39 @@ This is for in the future when I want to compress more images or anyone else for
 # Lossless
 
 ### https://squoosh.app/
-good at reducing the pallet, a first step for images that have a limited number of colors, bad at actually compressing things though, for all formats except webp.
+Good at reducing the pallet, a first step for images that have a limited number of colors, bad at actually compressing things though, for all formats except WEBP and PNG.
 
 ## PNGs:
-good ratios, though not as good as other options, though better compatibility
+Good ratios, though not as good as other options, though better compatibility.
+### oxipng
+*(you can also use through squoosh with the same results)*
+Seems to be the best of all of the options, not sure if it's all you would need, but it did shrink pngs further than the other two tools afterwards.
+```bash
+oxipng -o max --strip all --alpha <filename here>
+```
+`all` may be replaced with `safe` if you want to be a bit safer.
+
 ### pngcrush
-Good, but should be ran before optipng, but isn't as good as it, use in tandom
+Good, but should be ran before optipng, but isn't as good as it, use in tandom.
 ### optipng
-The best tool to really shrink pngs to be as small as they can be.
+The second best tool to really shrink pngs to be as small as they can be.
 
 ## WEBP
-it's better than png, though I have a feeling more could be done to compress these
+It's better than png, though I have a feeling more could be done to compress these
 ### cwebp
-so far this seems to be the best way to compress webp images with a command that kinda looks like this one
+So far this seems to be the best way to compress WEBP images with a command that kinda looks like this one:
 ```bash
 cwebp -lossless -z 9 in.webp -o out.webp
 ```
-while for all other formats squoosh is not recommended, for webp it'll be identical due to cwebp using the same libary as squoosh.
+While for all other formats squoosh is not recommended, for WEBP it'll be identical due to cWEBP using the same libary as squoosh.
 
 ## AVIF
 As far as I can tell, this format just sucks at its job, at least for lossless images
 
 ## JPEGXL
-Really good at compression size, though it's not supported anywhere outside of safari as of now.
+Really good at compression size, though it's not supported anywhere outside of Safari as of now.
 ### cjxl
-this command should do the trick for compressing
+This command should do the trick for compressing:
 ```bash
 cjxl input.png output.jxl -q 100 -e 10
 ```
@@ -35,6 +43,6 @@ cjxl input.png output.jxl -q 100 -e 10
 
 ## SVGs:
 ### https://svgomg.net/
-great tool, if anyone knows how to squish them further, let me know, some manual work may go a long way to help shrink svgs, though I'm not doing that right now lol.
+Great tool! If anyone knows how to squish them further, let me know! Some manual work may go a long way to help shrink SVGs, though I'm not doing that right now lol.
 
-I may look into other formats soon as well, though these are the main two I'm currently using
+I may look into other formats soon as well, though these are the main two I'm currently using.

Dockerfile

@@ -0,0 +1,18 @@
+FROM node:18-bullseye AS builder
+
+WORKDIR /devel
+RUN apt-get update ; apt-get upgrade -y ; apt-get install -y build-essential
+COPY . .
+RUN npm i ; npm run build
+
+FROM node:20-alpine
+
+EXPOSE 8080
+WORKDIR /exec
+RUN apk add --update nodejs npm
+COPY --from=builder /devel/ . 
+RUN adduser -D jankclient
+
+USER jankclient
+
+CMD ["npm", "start"]

InstanceInfo.md

@@ -1,15 +1,15 @@
-# How to add your instance to Jank Client
-inside of webpage you'll see a file called `instances.json` in that file you'll need to add your instance and its information in the following format if you want your instance to be a part of the drop down.
+# How to add your instance to Fermi Client
+Inside of `webpage` you'll see a file called `instances.json` in that file you'll need to add your instance and its information in the following format if you want your instance to be a part of the dropdown.
 ```
 {
     "name":<name>,
-    "description"?:<short description>,
+    "description"?:<A short description>,
     "descriptionLong"?:<A description for the instance that can be longer>,
-    "image"?:<URL to image repersenting your instance>,
+    "image"?:<URL to image representing your instance>,
     "url"?:<The URL that can be used to get your wellknown>,
-    "language":<what language your server is in>,
-    "country":<what country your server is in>,
-    "display":<true or false depending on wether it should display>,
+    "language":<What language your server is in>,
+    "country":<What country your server is in>,
+    "display":<True or false depending on wether it should display>,
     "urls"?:{
         "wellknown":<wellknown URL>,
         "api":<API URL>,
@@ -19,26 +19,27 @@ inside of webpage you'll see a file called `instances.json` in that file you'll
     },
     "contactInfo"?:{
         "discord"?:<Discord @>,
-        "github"?:<github profile URL>,
-        "email"?:<email address>,
-        "spacebar":?:<spacebar username>,
-        "matrix"?:<matrix account>,
-        "mastodon"?:<mastodon account>
+        "github"?:<Github profile URL>,
+        "email"?:<Email address>,
+        "spacebar":?:<Spacebar username>,
+        "matrix"?:<Matrix account>,
+        "mastodon"?:<Mastodon account>
     }
 }
 ```
-anything with a `?` in-front of its `:` are optional, though you must either include `"URL"` or `"URLs"`, but you may include both, though the client will most likely ignore `"URLs"` in favor of `"URL"`, though it may use `"URLs"` as a fallback if `"URL"` does not resolve, do not rely on this behavior.
-wellknown should be a url that can resolve the wellknown, but it should only be the base URL and not the full wellknown url.
+Anything with a `?` in-front of its `:` are optional, though you must either include `"URL"` or `"URLs"`, but you may include both, though the client will most likely ignore `"URLs"` in favor of `"URL"`, though it may use `"URLs"` as a fallback if `"URL"` does not resolve, do not rely on this behavior.
+`wellknown` should be a url that can resolve, but it should only be the base URL and not the full wellknown URL.
 Some of these values may not be used right now, though they will likely be used in the future, so feel free to fill out what you like, though the more you fill out the more information we can give the users about your instance in the future.
-language should be [ISO 639-1](https://en.wikipedia.org/wiki/ISO_639-1_codes).
-Country should be [ISO 8166-2 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2).
-You can also add yourself to [this](https://github.com/spacebarchat/spacebarchat/tree/master/instances) list, and you should, though there are some disadvantages to only being in that list
+`language` should be [ISO 639-1](https://en.wikipedia.org/wiki/ISO_639-1_codes).
+`country` should be [ISO 8166-2 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2).
+You can also add yourself to [this](https://github.com/spacebarchat/spacebarchat/tree/master/instances) list, and you should, though there are **some disadvantages** to only being in that list such as not being on the Fermi Discovery list which shows Guilds more higher up on the Fermi client, etc.
+
 # Questions
-## Do I have to do this to let Jank Client connect to my server?
-No, you may choose to not do this, this just makes it easier for people using Jank Client to find and use your instance as it's in the dropdown menu for instances, though the user may enter any instance they please.
-## If my instance isn't spacebar is that allowed to be entered?
-If it's spacebar compatable, yes it may be entered, though if there are too many incompatablities, it may not be included, or may need a warning of sorts.
-## I'm hosting my own instance of spacebar and would like to change the defualt instance on my instance of Jank Client to my own instance.
+## Do I have to do this to let Fermi Client connect to my server?
+No, you may choose to not do this, this just makes it easier for people using Fermi Client to find and use your instance as it's in the dropdown menu for instances, though the user may enter any instance they please.
+## If my instance isn't Spacebar is that allowed to be entered?
+If it's Spacebar compatible then yes, it may be entered. Though if there are **too many incompatibilities** however, it may not be included, or may need a warning of sorts.
+## I'm hosting my own instance of Spacebar and would like to change the default instance on my instance of Fermi Client to my own instance.
 Just change the first entry in the list to your own, and it should connect without issue.
-## Why would I put my instance in this list over the official spacebar list?
-While putting your instance in the other list will get it to show up on jank client, this list does have more settings, and will show up earlier in the results, though either list will work to get in the dropdown menu
+## Why would I put my instance in this list over the official Spacebar list?
+While putting your instance in the other list will get it to show up on Fermi client, this list does have more settings, and will show up earlier in the results, though either list will work to get in the dropdown menu.

README.md

@@ -1,24 +1,37 @@
-# Jank Client
-Jank Client is a [Spacebar](https://spacebar.chat) Client written in TS, HTML, and CSS.
+# Fermi
+Fermi is a [Spacebar](https://spacebar.chat) Client written in TS, HTML, and CSS.
 
-To run it, clone the repo and do `npm install`, then
-`node index.js`
-or do the equivalent with bun
+![](src/webpage/home/SS1.webp)
+
+To build it, clone the repo and run `npm install`, then `npm run build`
+To run it, use `npm start`
+or do the equivalent with bun.
 
 Both [Bun](https://bun.sh) and [Node.js](https://nodejs.org) are supported, and should function as expected.
 
-To access Jank Client after starting, simply go to http://localhost:8080/login and either register a new account, or log in with your email and password.
+To access Fermi after starting, simply go to http://localhost:8080/login and either register a new account, or log in with your email and password.
 
 If there are any issues please report them either here, or to me dirrectly on spacebar
 ## Adding instances to the dropdown
-Please see [this](https://github.com/MathMan05/JankClient/blob/main/InstanceInfo.md) for how to add an instance to the dropdown picker
+Please see [this](https://github.com/MathMan05/Fermi/blob/main/InstanceInfo.md) for how to add an instance to the dropdown picker.
+## How to statically host Fermi
+[Click here](./howToStaticallyHost.md)
 ## RoadMap
 You can view the current roadmap on https://github.com/users/MathMan05/projects/1.
 ## AI Code
-AI code due to not being GPLv3 compatable is not allowed in this repo. I thought this didn't need to be said, but it doesn't.
+AI code due to not being GPLv3 compatable is not allowed in this repo. I thought this didn't need to be said, but it does.
+And to be clear, *any* use of AI is not allowed in Fermi.
 ## Link
-The official SpaceBar server for Jank Client https://jankclient.greysilly7.xyz/invite/USgYJo?instance=https%3A%2F%2Fspacebar.chat
+The official Spacebar server for Fermi: https://fermi.chat/invite/USgYJo?instance=https%3A%2F%2Fspacebar.chat
+
+The current hosted instance of Fermi: https://fermi.chat/
 
-old invite for the official client https://dev.app.spacebar.chat/invite/USgYJo
+## Star History
 
-The current hosted instance of JankClient https://jankclient.greysilly7.xyz/
+<a href="https://www.star-history.com/#MathMan05/Fermi&Date">
+ <picture>
+   <source media="(prefers-color-scheme: dark)" srcset="https://api.star-history.com/svg?repos=MathMan05/Fermi&type=Date&theme=dark" />
+   <source media="(prefers-color-scheme: light)" srcset="https://api.star-history.com/svg?repos=MathMan05/Fermi&type=Date" />
+   <img alt="Star History Chart" src="https://api.star-history.com/svg?repos=MathMan05/Fermi&type=Date" />
+ </picture>
+</a>

SECURITY.md

@@ -0,0 +1,14 @@
+# Security Policy
+
+## Supported Versions
+
+Currently, I only support the most up to date version of Fermi client, there are no stable releases, but this is planned for in the future
+
+| Version | Supported          |
+| ------- | ------------------ |
+| main    | :white_check_mark: |
+
+
+## Reporting a Vulnerability
+
+If there's an issue please disclose it responsibly to me, or here on Github privately.