Skip to content
This repository has been archived by the owner on May 20, 2021. It is now read-only.

Commit

Permalink
update both readmes
Browse files Browse the repository at this point in the history
  • Loading branch information
CaseyFaist committed May 1, 2019
1 parent 0be6bb9 commit 44ec369
Show file tree
Hide file tree
Showing 2 changed files with 23 additions and 6 deletions.
23 changes: 20 additions & 3 deletions LOCALSETUP.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,13 +6,30 @@ After cloning this repo, here are the steps (not covered in the workshop) to get

[ ] `git clone repo`
[ ] [Python 3.7 installed locally](https://www.python.org/downloads/)

## Environment setup
[ ] `python3 -m venv djangowiki` to create an [environment](https://docs.python.org/3/library/venv.html)
[ ] `source djangowiki/bin/activate` (on Mac)
[ ] `pip install -f requirements.txt`
[ ] `pip install -r requirements.txt`
[ ] `cd` to the directory where `manage.py` lives
[ ] Drink some water and stretch out

## 1
## 3
Run the following command:

`cd` to the directory where `manage.py` lives and run the following command:
`python3 manage.py migrate`

## 4
Next, create a superuser:

`python3 manage.py createsuperuser`

## 5
Locally, you can use either the provided `runserver` or `gunicorn` for dev-prod parity. Either command works:

`python3 manage.py runserver`

-OR-

`gunicorn dynowiki.wsgi`

6 changes: 3 additions & 3 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,17 +6,17 @@ Originally created for PyCon 2019 Heroku Workshop, this project demonstrates the

This project utilizes [Django-Wiki](https://github.com/django-wiki/django-wiki), but this project ideally models what any locally built and working project can update to become productionized.

With that in mind, here are the specific changes needed to get a locally running app with minimal adjustments from the original `startapp` configuration deployed!
With that in mind, here are the specific changes needed to get a locally running app with minimal adjustments from the original `startproject` configuration deployed!

>Note: To clone and run this project locally from scratch, check out the related
guide [LOCALSETUP.md](LOCALSETUP.md)
>Note: To clone and run this project locally from scratch, check out the related guide [LOCALSETUP.md](LOCALSETUP.md)
## Step 1: Create a .gitignore

This will enable you to smoothly run your application locally and in production with minimal headache.

In addition to whatever you'd normally place in your .gitignore, be sure to
[untrack](https://git-scm.com/docs/git-rm#Documentation/git-rm.txt---cached) the following files:

```
/your-venv-directory
__pycache__
Expand Down

0 comments on commit 44ec369

Please sign in to comment.