- Installation process
- Install database on local machine. - How and where would I get the database?
- Clone or download repository to local machine folder. - Show command.
E.g. git clone {repo url}
- Create database and schema from the root of the local folder by running command "dotnet ef database update" - Use backticks (`) in markdown to format the commands to run
- From the root of the local folder run command "dotnet run" on command prompt
- Software dependencies/pre-requisites - This section should come first
- Git - The documentation is hosted in GitHub so this isn't needed
- Visual Studio 2019 - Links to relevant downloads is 👍
- .Net core SDK 3.1
- PostgreSql
* To build the application use "dotnet build" - **More description needed here**
* To run unit tests for the application use "dotnet test"
- Clone this repo to your local machine
git clone
- Download and install a local copy of the database. See phila.city for information on how to access this project's AWS infastructure.
cd
into the folder you just cloned and rundotnet ef database update
to create the database and schema.- Use
dotnet run
to run the application locally.
Run dotnet test
to run local tests
Use dotnet build
to build the application for deployment.
To deploy to the test environment, merge a pull request into the master branch.
To promote a build to production, rebase your production branch against the latest master. Deployment uses GitHub actions, so make sure to keep an eye on it to confirm the deployment is successful.