Skip to content

Commit

Permalink
Merge pull request psf#22 from aeltanawy/master
Browse files Browse the repository at this point in the history
19: Improve installation instructions
  • Loading branch information
meg-ray authored May 16, 2021
2 parents 1d77f74 + 5e6b501 commit 7df7d2e
Showing 1 changed file with 34 additions and 2 deletions.
36 changes: 34 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,7 @@ All contributors must agree to abide by our [Code of Conduct](https://github.com

## Installation Guide

In order to run this site locally, you'll want to clone this repository and install the requirements:
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):

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

You can then change directories into the python-in-edu folder and run the following command in the terminal:
You can then change directories into the python-in-edu folder and build the database:

```
python manage.py migrate
```


To run the project locally, run the following command in the terminal:

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

We use the [Spirit project](https://spirit-project.com/) for our forums.

---

<h2 id="mac-troubleshooting">Mac Troubleshooting</h2>

### Postgres

If you don't have an installation of Postgres on your system, you might run into the following error:

```
Error: pg_config executable not found.
```

[Install Postgres](https://postgresapp.com/) to resolve this issue.

### Pillow

If your Pillow installation fails during installing the requirements with the following message:

```
The headers or library files could not be found for jpeg,
a required dependency when compiling Pillow from source.
```

You can resolve this by installing [jpeg](https://formulae.brew.sh/formula/jpeg) using [homebrew](https://brew.sh/).

0 comments on commit 7df7d2e

Please sign in to comment.