ChoreHelper

It's easy to get behind in home maintenance/chores and it's easy to stop seeing the tasks that need to be done. Rather than relying on someone else to communicate the problems, ChoreHelper aims to offer you an option so you can fix the problem yourself.

Prerequisites

.NET 5.0

.NET is the framework under the WebAPI application

For more information look here.

Node

Node is the runtime under the Angular application

For more information look here

Docker

Docker is leveraged for automation and assures boundary separation

For more information look here

Postman

API integration tests are written in Postman

For more information look here

Newman

Extracted Postman tests are run via Newman

For more information look here

Local Development

For development insights specific to the Angular ChoreUI application view the readme here.

For development insights specific to the .NET WebAPI application view the readme here.

Database

You can spin up an instance of postgres via docker-compose. Run docker-compose up from the root directory and wait for Flyway to complete it's migration. For more information on Flyway Migrations see here.

To connect to the desktop via PgAdmin open a browser to localhost:5431 then perform the following tasks.

Right click the Servers node in the left-side browser and click Create > Server. Enter a name in the General tab. Click the Connection tab. Enter host.docker.internal in the Host name/address field. Enter docker in the user name and in the password field. Click the Save button.

Docker Images

For more information on the Docker images used in this repository refer to the following links:

• Flyway
• PgAdmin
• Postgres
• ASP.NET SDK
• ASP.NET Runtime
• node
• nginx

Local Testing

A docker-compose-full-integration definition file is available for use which establishes a full application stack for local testing.

To run the docker-compose run

docker-compose -f .\docker-compose-full-integration.yml up

To view the Chore UI, navigate to localhost:4200

To view the WebAPI, navigate to localhost:5000

Integration Tests

The API integration tests are written in Postman and run via the following command in the root directory.

newman run .\tests\Chores.postman_collection.json

Cleanup

To clean up the containers use Ctrl+C followed by running

docker-compose -f .\docker-compose-full-integration.yml down

Build

If the images are stale and you wish to rebuild them run

docker-compose -f .\docker-compose-full-integration.yml build