TrueVote.Api is the core backend for TrueVote.
The main technology stack platform is .NET Core 6.0 (preview).
- Install Visual Studio 2022 (preview) or later, or Visual Studio Code. Ensure that
$ dotnet --versionis at least 6.0.
- Install Azure CosmosDB Emulator
⌨️ Install, Build, and Serve the Site
Create a new file at the root of TrueVote.Api named
local.settings.json and add the following, replacing the account key with the actual account key from the CosmosDB Emulator start page. To use the functions of the Telegram Bot locally, create a new Bot using 'BotFather' and place the key in the
Open the TrueVote.Api.sln solution in Visual Studio, and build the solution.
You'll see output in the console showing the various local URL access points.
REST Api root
🧪 Unit Testing
Unit testing and code coverage are setup and must be maintained. To run the tests and generate a coverage report, run the Powershell script from the command line.
This generages a coverage report in
index.html to view the report.
TrueVote.Api uses sementic versioning, starting with 1.0.0.
The patch (last segment of the 3 segments) is auto-incremented via a GitHub action when a pull request is merged to master. The GitHub action is configured in the .github/workflows/developer-guide.yml file. To update the major or minor version, follow the instructions specified in the bumping section of the action - use #major or #minor in the commit message to auto-increment the version.
We welcome all contributions. Please read our contributing guidelines before submitting a pull request.
TrueVote.Api is licensed under the MIT license.