comparehare

For a general idea of the app and its architecture, please read ARCHITECTURE.md

Getting Started

Prerequisites

• .NET 8+ installed
• MySQL/MariaDB docker image instantiated and configured
• Nuget package manager
• Yarn package manager

Developing (order is important)

1. Check CompareHare.Api/appsettings.json for connection details, ensure you create your MySQL container according to those specs, as such: docker run --detach -p 3307:3306 --name mariadb-matt -e MARIADB_ROOT_PASSWORD=P@ssw0rd! mariadb:latest also, make sure to create 2 databases: comparehare and comparehare-hangfire. If running for the first time, run dotnet ef database update before running dotnet run

2. cd src/CompareHare.React then run yarn to install dependencies.

3. Run yarn start to start the development server. It should automatically open the client in your browser when ready.

4. Once the React app is up, you may then start the API, which both spins up the Web API server as well as the Hangfire background jobs, one of which (the offer loader job) will require a static resource that Webpack serves up for mocking purposes. (for now, in "production" it will scrape the legit URLs)

5. First, let's restore Nuget packages. Open a new terminal tab and cd src and then run dotnet restore

6. Now, lets run any migrations. cd CompareHare.Api then (making sure the specified MySQL database is running - locally, Docker image) dotnet ef database update

7. Finally, lets get this puppy running. Stay in the CompareHare.Api folder, then run dotnet run

Migrations

I forgot how to do this, here's how:

1. Update all of the entities/relationships in CompareHare.Domain

2. If adding any new entities, you need to make sure the DbContext has an entry for them, or else Dotnet won't see them! Also, update DbContext with any relationship additions/changes.

3. In a terminal window, cd src/CompareHare.Api then run the command to generate a new migration based off a diff between the current schema and the changes: dotnet ef migrations add <YourMigrationNameHere>

4. If you hit issues, tag a --verbose on the end to debug the issue (very common - fix your code!)

5. Once the migration Up/Down that was created is sufficient, run the migration: dotnet ef database update (if this fails, ensure the dotnet tooling is installed: dotnet tool install --global dotnet-ef)

6. If anything fails, you can select to rollback changes with dotnet ef database update <FULL text name of last successful migration> (includes the numbers in the migration file name)

Hangfire

In order to see/trigger background jobs, go to http://localhost:53041/background-jobs when the API/Hangfire is running

Testing

1. Ensure all packages are restored: cd src then dotnet restore

2. Then, you should be able to run all XUnit tests with dotnet test

3. TBD: Front end testing with Jest

Tricky stuff

• Getting "second selector undefined"? Yeah, this likely means you either fat-fingered the name of a base selector, OR, you need to stop and re-start yarn start so it can run all of those goofy scripts that re-generates the index files (including reducers)