jank-client-fork/README.md
2025-03-16 15:44:08 -05:00

24 lines
1.3 KiB
Markdown

# Jank Client
Jank Client is a [Spacebar](https://spacebar.chat) Client written in TS, HTML, and CSS.
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.
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
## 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 does.
## Link
The official SpaceBar server for Jank Client https://jankclient.greysilly7.xyz/invite/USgYJo?instance=https%3A%2F%2Fspacebar.chat
old invite for the official client https://dev.app.spacebar.chat/invite/USgYJo
The current hosted instance of JankClient https://jankclient.greysilly7.xyz/