From 87d35cdf7ccfa1d8245f40694876148a36501e97 Mon Sep 17 00:00:00 2001 From: Abeer Eltanawy Date: Sat, 15 May 2021 13:56:29 +0200 Subject: [PATCH 1/3] 19: Improve installation instructions -Added extra installation instructions for Mac users -Added database setup using migrate command --- README.md | 36 ++++++++++++++++++++++++++++++++++-- 1 file changed, 34 insertions(+), 2 deletions(-) diff --git a/README.md b/README.md index 315d3f7..5a1b8f0 100644 --- a/README.md +++ b/README.md @@ -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 @@ -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 @@ -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. + +--- + +

Mac Troubleshooting

+ +### 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/). From 1fcf6a4809789c577d536a523f42d1df42c30ea0 Mon Sep 17 00:00:00 2001 From: Abeer Eltanawy Date: Sat, 15 May 2021 15:59:30 +0200 Subject: [PATCH 2/3] Revert "19: Improve installation instructions" to add co-authors This reverts commit 87d35cdf7ccfa1d8245f40694876148a36501e97. --- README.md | 36 ++---------------------------------- 1 file changed, 2 insertions(+), 34 deletions(-) diff --git a/README.md b/README.md index 5a1b8f0..315d3f7 100644 --- a/README.md +++ b/README.md @@ -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 (check the [Mac Troubleshooting](#mac-troubleshooting) section if you face any errors): +In order to run this site locally, you'll want to clone this repository and install the requirements: ``` git clone https://github.com/psf/python-in-edu.git @@ -18,14 +18,7 @@ source .venv/bin/activate pip install -r requirements.txt ``` -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: +You can then change directories into the python-in-edu folder and run the following command in the terminal: ``` python manage.py runserver @@ -50,28 +43,3 @@ 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. - ---- - -

Mac Troubleshooting

- -### 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/). From 5e6b50136add1d901a1ed84a63a766a74c827763 Mon Sep 17 00:00:00 2001 From: Abeer Eltanawy Date: Sat, 15 May 2021 16:01:17 +0200 Subject: [PATCH 3/3] 19: Improve installation instructions Co-authored-by: Martin Breuss breuss.martin@gmail.com -Added extra installation instructions for Mac users -Added database setup using migrate command --- README.md | 36 ++++++++++++++++++++++++++++++++++-- 1 file changed, 34 insertions(+), 2 deletions(-) diff --git a/README.md b/README.md index 315d3f7..7628309 100644 --- a/README.md +++ b/README.md @@ -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 @@ -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 @@ -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. + +--- + +

Mac Troubleshooting

+ +### 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/). \ No newline at end of file