This project is the backend component of a notes application based on a tutorial by Chris Blakely, found here.
This is a port from Node.js to ASP.Net Core Web API using C# and Entity Framework Core instead of Prisma. In addition, Liquibase is used for the database migration instead of Entity Framework.
The React front-end for the completed tutorial can be found in my other repository here. The original Node.js version can be found in my other repository here.
The original tutorial relies on hosting a Postgres database on a free 3rd party site and using Prisma to push the schema. Instead, I have created a docker compose file that includes the following:
- Postgres hosted on port 5432. User: admin, password: root
- pgAdmin4 to allow using a GUI to perform tasks on the database*
- Liquibase to generate the database and notes table. This will allow change tracking in the repository and has potential for setting up easy integration tests.
- The liquibase command will automatically run when the container starts up and only apply changesets not yet applied.
To run the docker compose file, you can go into the etc folder and run docker compose -f .\pg-docker-compose.yml up -d. To bring it down you can run docker compose -f .\pg-docker-compose.yml down.
You will of course need docker installed to do this.
* You may need to connect to the database using the IP address instead of localhost, though this may have only been an issue for me hosting both projects inside of WSL. To get the IP, you can run a docker ps command to get the id of the postgres container, then run docker inspect {container-id} to find the IP Address.
This project also has Swagger included to generate API docs that fit with the OpenAPI specification (OAS).