Skip to content

Web Fermi

Fermi is under heavy development but may be used as it's still rather complete

Fermi is currently being developed at this repository.

Official host

Fermi is officially hosted here

Note

Fermi supports pointing to your own instance by default, you can read about it here

Warning

If you want you instance to play nice with other instances of Fermi using their account switchers, you need to disable CORS, or allow requests from the instances of Fermi you trust

Setup/Building

Dependencies

In your terminal:

# Download Fermi
git clone https://github.com/MathMan05/Fermi.git

# Enter the cloned directory
cd Fermi

# Install dependencies
npm i

# Or if you're on bun
bun i
then build Fermi

npm run build

#or if you're on bun
bun run build

To start Fermi, run

npm run start

# If you're using bun
bun run start

Note

Fermi defaults to opening on port 8080, if you want to change the port you'll need to change either the env variable PORT or put the port on the command you run, ex: npm start ./dist/index.js 43

Warning

DO NOT edit the default port in index.ts, use Environment=PORT=1234 in your systemd service file instead!

If you're wanting to also develop Fermi, you'll need to start the typescript compiler in watch mode on the base directory of the project.

Contributing

To contribute:

  • Fork Fermi
  • Run the building instructions.
  • Commit & push.
  • Pull request & done!

What can I contribute?

  • More settings, and general bug fixes, CSS improvements or anything you think needs to be fixed/improved
  • This is a good list for things that need to be done, though it's incomplete, so if you think something is missing and you want to add it, just do it! MathMan05 is more than willing to answer your questions if you have any!
  • Even if you can't code, there's stuff you can still do! Like reporting bugs, or updating the documentation!
  • If you have a Harmony instance you can put it on Fermis instance list
  • Translation work would also be very appreciated. you can do it here if you like