fluxel

The backend for fluXis.

Building and Developing

Requirements

• A desktop computer running Windows, macOS, or Linux with the .NET 8.0 SDK installed.
• An IDE of your choice, for example JetBrains Rider, Visual Studio or Visual Studio Code.

Downloading the source code

You can download the source code by cloning the repository using git:

git clone https://github.com/InventiveRhythm/fluxel

Make sure the fluXis repo is cloned next to where the fluxel repo is.

Your filesystem should look like this if done correctly:

~/GitHub/InventiveRhythm> ls
fluXis
  fluXis/
  fluXis.Resources/
  fluXis.sln
  ...
fluxel
  fluxel/
  fluxel.Startup/
  fluxel.sln
  ...

To update the source code to the latest version, run the following command in the repository directory:

git pull

Building

When running the project for the first time, make sure to copy default.env to .env.

To build and run the project, execute the following command in the repository directory (the folder where fluxel.sln is located):

dotnet run --project fluxel.Startup

License

fluxel is licensed under the MIT License. tl;dr: You can do whatever you want with the code, as long as you include the original license.