fuel-wizard/fuel-wizard
fuel-wizard/fuel-wizard
2
2
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

Update README.md

Browse Source
This commit is contained in:
kurt-mcrae 2025-05-03 17:15:45 +10:00
parent c623b8431c
commit e07fd5a797
1 changed files with 1 additions and 1 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

2
README.md
View File

@ -19,7 +19,7 @@ A local **TimescaleDB** instance is used for persistence, and more complex queri
### Linux
To run a local development instance of the application, a TimescaleDB instance must be set up. This can be done quickly and easily through Docker, by utilising the docker-compose config found at: `backend/Database/Deployment/compose.yaml`. You can reference the Timescale docs for how to set up the database using docker here: https://docs.timescale.com/self-hosted/latest/install/installation-docker/ .
Once the database is running, you can get a development environment set up for the API. You will need .NET SDK 9 installed on your machine: https://learn.microsoft.com/en-us/dotnet/core/install/linux . I would recommend using an IDE to run, debug, and edit the application code. Most of the development work has been done using **JetBrains Rider**, purely because it is an excellent IDE (especially when compared to Visual Studio). I can also highly recommend **VSCodium**, which is FOSS, and has pretty good support for C#.
Once the database is running, you can get a development environment set up for the API. You will need .NET SDK 9 installed on your machine: https://learn.microsoft.com/en-us/dotnet/core/install/linux . I would recommend using an IDE to run, debug, and edit the application code. Most of the development work has been done using **JetBrains Rider**, though I'd like to move entirely to **VSCodium** (which I use for the front end) at some point.
You can build and run the .NET app in the usual way with the CLI, or through your IDE of choice, and then navigate to the Swagger endpoint to see the API spec, and try out some requests. This should be: `http://localhost:5161/swagger/index.html`, but double-check the port if you can't see anything (the application console will output a line on startup detailing which port the server has started on).