Vote Monitor

Technologies & Libraries

• FastEndpoints
• FluentValidation
• Ardalis.Specification
• Ardalis.SmartEnum
• XUnit
• TestContainers
• FluentAssertions
• Bogus

Getting started using docker

1. Rename .env.example to .env
2. Build the project

   docker compose build
   

3. Start project

   docker compose up -d 
   

4. Seed platform admin

   {
       "Seeders": {
            "PlatformAdminSeeder": {
                "FirstName": "John",
                "LastName": "Doe",
                "Email": "[email protected]",
                "PhoneNumber": "1234567890",
                "Password": "<your-password>"
           }
       }
   }

5. Navigate to http://localhost:5000/swagger/index.html
6. Obtain token

   POST /api/auth
   {
       "username": "<your-username>",
       "password": "<your-password>"
   }
   

7. Enjoy

Getting started using VisualStudio

1. start a postgres instance
2. update appsettings.Development.json
3. Build
4. Run and debug
5. Enjoy

Adding EF migrations

Run the following command in the project root folder

dotnet ef migrations add MyNewMigration --project .\src\Vote.Monitor.Domain --startup-project .\src\Vote.Monitor.Api

Polling stations feature

documentation

Configuration

File Storage

For local development you can use your local file system for storage by setting the file storge type in appconfig as follows.

 "FileStorage": {
   "FileStorageType": "LocalDisk",
   "LocalDisk": {
     "Path": "Uploads"
   },
   "S3": {
     ...
   }
 }

To use S3 file storage, you need to set "FileStorageType": "S3", and need to have the following environment variables set, with the key ID referencing an IAM user with permissions restricted to only S3.

 "AWS_ACCESS_KEY_ID": "",
 "AWS_SECRET_ACCESS_KEY": "",
 "AWS_REGION": ""

Alternatively, you can use a locally configured aws profile.