Skip to content

Commit 92d152e

Browse files
Add instructions to run the server
1 parent 7e6dec4 commit 92d152e

File tree

1 file changed

+10
-0
lines changed

1 file changed

+10
-0
lines changed

readme.md

+10
Original file line numberDiff line numberDiff line change
@@ -26,6 +26,16 @@ To set up a catalog (including courses and requirements lists):
2626

2727
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`.
2828

29+
## Running the Server
30+
31+
To run the server (with the conda environment activated), use
32+
33+
```
34+
python manage.py runserver
35+
```
36+
37+
By default, the server runs on port 8000. You can specify a different port by simply adding the port number after the `runserver` command. (The `manage.py` script is [provided by Django](https://docs.djangoproject.com/en/1.11/ref/django-admin/) and provides other useful commands such as migrating the database, collecting static files, and opening an interactive shell.)
38+
2939
## Database Settings
3040

3141
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.

0 commit comments

Comments
 (0)