Skip to content

Commit

Permalink
Update readme with run instructions
Browse files Browse the repository at this point in the history
  • Loading branch information
kevinzwang committed Apr 6, 2023
1 parent 230e56b commit 20e63ef
Showing 1 changed file with 13 additions and 3 deletions.
16 changes: 13 additions & 3 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,9 +5,19 @@
A course discovery and planning tool which combines all of UC Berkeley's academic information in one place. We intend to make it a more accurate and powerful tool than anything students currently use.

Berkeleytime was created by [Yuxin Zhu](http://yuxinzhu.com/) and [Noah Gilmore](https://noahgilmore.com) and is maintained by [the ASUC Office of the CTO](https://octo.asuc.org/).
# Getting started

## Development
Start Docker before running these in repo root

Much of the current development is on [the node branch](https://github.com/asuc-octo/berkeleytime/tree/node).
```{bash}
docker-compose up # CTRL+C to stop
docker-compose down # cleaner shutdown, removes containers
```

It hasn't been updated recently, but this project does have [a wiki](https://github.com/asuc-octo/berkeleytime/wiki).
To seed the database, run these following commands while the containers are up. You will only need to do this once.
```{bash}
curl -O https://storage.googleapis.com/berkeleytime/public/mdb.archive
docker run --rm --volume "${PWD}/mdb.archive":/mdb.archive --network bt mongo:5 mongorestore --drop --host mongodb --gzip --archive=mdb.archive
```

Local site becomes available at http://localhost:8080

0 comments on commit 20e63ef

Please sign in to comment.