Skip to content

Commit

Permalink
Add prior art section to readme (#305)
Browse files Browse the repository at this point in the history
  • Loading branch information
terror committed Jun 21, 2023
1 parent e8bb1a8 commit 92f8159
Showing 1 changed file with 15 additions and 2 deletions.
17 changes: 15 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -26,8 +26,8 @@ initialize the database:
$ cargo run -- --source=seed serve --initialize --db-name=mcgill-courses
```

Refer to `.env.example` and `client/.env.example` for what environment variables
need to be set.
Refer to `.env.dev.example` and `client/.env.dev.example` for what environment
variables need to be set.

_n.b._ The server command-line interface provides a load subcommand for scraping
all courses from various McGill course information websites and building a JSON
Expand Down Expand Up @@ -75,3 +75,16 @@ Finally, spawn the react frontend:
$ npm install
$ npm run dev
```

### Prior Art

There are a few notable projects worth mentioning that are similar in nature to
[mcgill.courses](https://mcgill.courses), and have either led to inspiration or
new ideas with regard to its functionality and design, namely:

- [uwflow.com](https://uwflow.com/) - A course search and review platform for
the University of Waterloo
- [cloudberry.fyi](https://www.cloudberry.fyi/) - A post-modern schedule builder
for McGill students
- [mcgill.wtf](https://mcgill.wtf/) - A fast full-text search engine for McGill
courses

0 comments on commit 92f8159

Please sign in to comment.