Skip to content

Commit

Permalink
Add docs on updating
Browse files Browse the repository at this point in the history
  • Loading branch information
francojreyes authored Mar 29, 2024
1 parent 6da8491 commit ea0329b
Showing 1 changed file with 16 additions and 1 deletion.
17 changes: 16 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -49,4 +49,19 @@ The following relationships exist between tables. These relationships are tracke
- Every **building** contains 1 or more **rooms**
- Every **room** belongs to a **building**
- Every **room** has 0 or more **bookings**
- Every **booking** is for a specific **room**
- Every **booking** is for a specific **room**

## Making Changes
### Schema updates
To update the schema, you will need to:
- Update the relevant `up.sql` and `down.sql` files in the root `sql/` directory
- Update the scrapers to produce this data

### Adding additional scrapers
To add additional scrapers, you will need to:
- Create a new subdirectory with the scraper inside it
- Ensure that if you are using the schema SQL files, you reference them using symlinks so all scrapers are updated
- Add to the GitHub workflow so that it also tests/builds/deploys the new scraper

### Testing
See the [DevSoc GraphQL API docs](https://github.com/devsoc-unsw/graphql-api/blob/master/scrapers.md) on how to test scrapers.

0 comments on commit ea0329b

Please sign in to comment.