Skip to content

Commit 7df7d2e

Browse files
authoredMay 16, 2021

File tree

1 file changed

+34
-2
lines changed

1 file changed

+34
-2
lines changed
 

‎README.md

+34-2
Original file line numberDiff line numberDiff line change
@@ -8,7 +8,7 @@ All contributors must agree to abide by our [Code of Conduct](https://github.com
88

99
## Installation Guide
1010

11-
In order to run this site locally, you'll want to clone this repository and install the requirements:
11+
In order to run this site locally, you'll want to clone this repository and install the requirements (check the [Mac Troubleshooting](#mac-troubleshooting) section if you face any errors):
1212

1313
```
1414
git clone https://github.com/psf/python-in-edu.git
@@ -18,7 +18,14 @@ source .venv/bin/activate
1818
pip install -r requirements.txt
1919
```
2020

21-
You can then change directories into the python-in-edu folder and run the following command in the terminal:
21+
You can then change directories into the python-in-edu folder and build the database:
22+
23+
```
24+
python manage.py migrate
25+
```
26+
27+
28+
To run the project locally, run the following command in the terminal:
2229

2330
```
2431
python manage.py runserver
@@ -43,3 +50,28 @@ If you want to use or test email functionality locally, you'll need to [run a si
4350
## Notes
4451

4552
We use the [Spirit project](https://spirit-project.com/) for our forums.
53+
54+
---
55+
56+
<h2 id="mac-troubleshooting">Mac Troubleshooting</h2>
57+
58+
### Postgres
59+
60+
If you don't have an installation of Postgres on your system, you might run into the following error:
61+
62+
```
63+
Error: pg_config executable not found.
64+
```
65+
66+
[Install Postgres](https://postgresapp.com/) to resolve this issue.
67+
68+
### Pillow
69+
70+
If your Pillow installation fails during installing the requirements with the following message:
71+
72+
```
73+
The headers or library files could not be found for jpeg,
74+
a required dependency when compiling Pillow from source.
75+
```
76+
77+
You can resolve this by installing [jpeg](https://formulae.brew.sh/formula/jpeg) using [homebrew](https://brew.sh/).

0 commit comments

Comments
 (0)
Please sign in to comment.