Skip to content

Commit

Permalink
Update README.md
Browse files Browse the repository at this point in the history
  • Loading branch information
86LAK authored May 1, 2024
1 parent 1d7ea2f commit c38b2d7
Showing 1 changed file with 12 additions and 3 deletions.
15 changes: 12 additions & 3 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -32,10 +32,19 @@ This project is brought to you by the Evan Hughes FanClub. Our team consists of:

## Deployment

To deploy the application, follow these steps:
Deployment of UniBasement is managed via the GitHub Actions. This is the recommended and easiest way to deploy the application and automatically preserve the state files. The GitHub actions utilise and manage its state files in AWS via an S3 bucket. **Warning:** DO NOT RUN THE DEPLOY.SH LOCALLY TO DEPLOY OR TEARDOWN INFRASTRUCTURE.

1. Set your AWS credentials as environment variables.
2. Execute the `deploy.sh` script. This script should handle the deployment process. You can run it with the command `./deploy.sh` from your terminal.
1. Grab your AWS credentials from the UQ Token Machine (link on Blackboard)
2. Go to the Github Actions and find the ```Manual AWS Deployment``` workflow.
3. When prompted paste in the credentials and run the workflow off the main branch

## Teardown
Similar to Deployment.
**Warning:** DO NOT RUN THE DEPLOY.SH LOCALLY TO DEPLOY OR TEARDOWN INFRASTRUCTURE.

1. Grab your AWS credentials from the UQ Token Machine (link on Blackboard)
2. Go to the Github Actions and find the ```Manual AWS Teardown``` workflow.
3. When prompted paste in the credentials and run the workflow off the main branch

## Tests

Expand Down

0 comments on commit c38b2d7

Please sign in to comment.