localdevelopment.md

Running

After cloning the repository to your machine, ensure that you have .Net 6 installed. If that is working correctly you should be able to run the back end locally using the command,

$ dotnet run

this will start a dotnet API server that will listen on port 27000

$ dotnet watch --project API.csproj run -- --project API.csproj

This is used to start an application and automatically restart it whenever changes are detected in the source code. This is useful for development as it allows you to see changes in real-time without manually restarting the application.

When running properly, you should be able to access and test the API locally as seen in apiDoc.

Docker

This application can alternatively be deployed via a docker docker image. Assuming you have Docker installed, run the following:

docker build -t reduxapi .
docker run -it --rm -p 27000:80 --name reduxapi reduxapi

This will start a local server via docker. Note that this server is using production binaries, so warnings will be distinct from using dotnet run, which is not converted to a binary only standalone image.