Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

19: Improve installation instructions #22

Merged
merged 3 commits into from
May 16, 2021
Merged
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
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/).