Skip to content

basalt-rs/basalt

Repository files navigation

Basalt

Application for managing and competing in programming competitions

Note

MacOS Users: If opening Basalt Desktop gives you "Basalt Desktop.app is damaged and cannot be opened", MacOS is lying to you and you may just need to run sudo xattr -rd com.apple.quarantine /Applications/Basalt\ Desktop.app. Alternatively, you can open the Privacy & Security settings pane and scroll down to the Security section to remove the quarantine.

Windows Users: Defender may think Basalt Desktop is a virus. This just happens sometimes, and if SmartScreen blocks it from running, click "More Info" and "Run Anyways". Feel free to scan Basalt Desktop with Virustotal!

Development

  • Node: 20.17.0
  • Rust: 1.84

To get started, install the Tauri CLI (docs). We recommend using cargo.

git clone https://github.com/basalt-rs/basalt.git
cd basalt
cd client
npm i           # install node_modules
cargo tauri dev # launch dev server

Depending on your OS, you may be missing packages. The error messages should be informative. If all goes well, an application window will then spawn.

You can also access the web UI at http://localhost:3000.

Next you'll need a server and a game code. For the game code, you'll need the Basalt CLI. Please consult the docs for more info. For the server, check out the repo and follow its instructions for getting up and running.

Use the CLI to produce a game code for the same port on which your server is running. Afterwards, feel free to enter that game code into the user interface. Then log in with an account in your configuration.

We support hot-module-reloading (HMR), so changes will be reflected nearly immediately.

Issues

When creating an issue, you'll be given two templates (bug or feature request). Please provide all of the requested information if available. If not available, simply put "NA".

Contributing

On any of our issues, feel free to express your intention to contribute. You can also do this in our Discord.

Then just fork the project, make your changes, and create a pull request. We're available in the discord for a chat if you need some help.

About

Application for managing and competing in programming competitions

Topics

Resources

License

Stars

Watchers

Forks

Contributors 7

Languages