JackDanna / FogentRoleplayCharacterSheet

4 stars 0 forks source link

Fogent Roleplay Character Sheet

This is a application for managing Fogent Roleplay Characters. It was built from the SAFE Stack. It was created using the dotnet SAFE Template. If you want to learn more about the template why not start with the quick start guide?

Part 1: Installing pre-requisites:

Option A: Install pre-requisites with flake.nix

You'll need to install/enable the following pre-requisites in order to build the app.

Enter this repositories directory and run the following on the command line:

nix run

This will install all dependencies and development tools. You'll then be droped into a vscode enviroment with all the recommend F# plugins installed.

Option B: Install pre-requisites manually

You'll need to install the following pre-requisites in order to build SAFE applications

Part 2: Starting the application

The application uses the FogentRoleplayData repository as a git submodule, which contains .csv files with all the data on the settings it supports. Run the following command to pull it down.

git submodule update --recursive --remote

Before you run the project for the first time only you must install dotnet "local tools" with this command:

dotnet tool restore

To concurrently run the server and the client components in watch mode use the following command:

dotnet run

Then open http://localhost:8080 in your browser.

The build project in root directory contains a couple of different build targets. You can specify them after -- (target name is case-insensitive).

To run concurrently server and client tests in watch mode (you can run this command in parallel to the previous one in new terminal):

dotnet run -- RunTests

Client tests are available under http://localhost:8081 in your browser and server tests are running in watch mode in console.

Finally, there are Bundle and Azure targets that you can use to package your app and deploy to Azure, respectively:

dotnet run -- Bundle
dotnet run -- Azure

SAFE Stack Documentation

If you want to know more about the full Azure Stack and all of it's components (including Azure) visit the official SAFE documentation.

You will find more documentation about the used F# components at the following places: