Skip to content

Commit 66e7f14

Browse files
Add catalog setup to readme
1 parent 9ffa769 commit 66e7f14

File tree

1 file changed

+14
-4
lines changed

1 file changed

+14
-4
lines changed

readme.md

Lines changed: 14 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -8,23 +8,33 @@ Follow these instructions to set up and run your own instance of the FireRoad se
88

99
```
1010
conda create -n fireroad python=2.7
11-
source activate fireroad
11+
conda activate fireroad
1212
```
1313

1414
Then, enter the repo directory and run the setup script, which will install any necessary packages and set up the database.
1515

1616
```
17-
$ cd fireroad-server
18-
$ ./setup.sh
17+
cd fireroad-server
18+
./setup.sh
1919
```
2020

21+
To set up a catalog (including courses and requirements lists):
22+
23+
```
24+
./setup_catalog.sh
25+
```
26+
27+
This script will prompt you to download a copy of the course catalog from the [prod site](https://fireroad.mit.edu/courseupdater/download_data) if you have not already. Otherwise, you can run the catalog setup script without pre-initialized catalogs, then run the scraper yourself following the instructions in `data/readme.md`.
28+
29+
## Database Settings
30+
2131
Note that the project contains three Django settings modules: `fireroad/settings.py` (local development), `fireroad/settings_dev.py` (dev server), and `fireroad_settings_prod.py` (prod server). When making changes to the settings, please make sure to change the file appropriate to the environment on which you want the changes to take effect (and note that the latter two import the base `settings.py` file). In order to specify which settings module should be used, you will need to set the `DJANGO_SETTINGS_MODULE` environment variable to `fireroad.settings{VARIANT}`, and change the default value specified in `fireroad/wsgi.py` if deploying with WSGI.
2232

2333
Depending on your settings, there may be additional files that you can add to enable certain capabilities:
2434

2535
* To use a MySQL database, add a `fireroad/dbcreds.py` file that specifies the necessary authentication info as Python variables `dbname`, `username`, `password`, and `host`.
2636
* To enable sending emails to admins for unresolved edit requests, etc., create an email address with two-factor authentication disabled (gmail works well). Then add a `fireroad/email_creds.py` file that specifies authentication info as a comma-delimited string with three components: the email server (e.g. `smtp.gmail.com`), the email address, and the password for the email account.
2737

28-
### API Endpoints
38+
## API Endpoints
2939

3040
The FireRoad API is fully documented at [fireroad.mit.edu/reference](https://fireroad.mit.edu/reference) (dev version at [fireroad-dev.mit.edu/reference](https://fireroad-dev.mit.edu/reference)). When submitting PRs that modify the behavior of these endpoints or add new ones, please update the docs in `common/templates/docs` accordingly.

0 commit comments

Comments
 (0)