mirror of
https://github.com/MathMan05/Fermi.git
synced 2026-05-16 18:45:32 +00:00
MathMan05
38 lines
1.7 KiB
Markdown
38 lines
1.7 KiB
Markdown
# Fermi
|
|
Fermi is a [Harmony](https://redir.fermi.chat/server) 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 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/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 does.
|
|
And to be clear, *any* use of AI is not allowed in Fermi.
|
|
## Link
|
|
The official Spacebar server for Fermi: https://redir.fermi.chat/invite
|
|
|
|
The current hosted instance of Fermi: https://fermi.chat/
|
|
|
|
## Star History
|
|
|
|
<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>
|