Skip to content

readme/dev setup improvements #24

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.

Sign up for GitHub

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

Merged
smajda merged 3 commits into from
Oct 10, 2015
Merged

readme/dev setup improvements #24

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
9c3503a
.env does not need to be a shell script
smajda Aug 8, 2015
e60a62b
Improve vagrant instructions in vagrant
smajda Aug 8, 2015
29859c3
Also may need to install vbguest plugin
smajda Aug 8, 2015
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
17 changes: 16 additions & 1 deletion README.markdown
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -6,13 +6,22 @@ Files for the PythonKC.com website.

## Development Quickstart Option 1 (vagrant)

First, copy `pythonkc_site/.env.example` to `pythonkc_site/.env` and add
We're going to use Vagrant and Virtualbox to run pythonkc.com inside a Debian
VM. We're using the [shell provisioner][] to install Ansible inside our VM and
then using Ansible to manage the environment from there. (Note: we're *not*
using the [ansible provisioner][].)

First you need to install [Vagrant][] and [VirtualBox][] and clone [our
repository][] from github.

Now copy `pythonkc_site/.env.example` to `pythonkc_site/.env` and add
your own [meetup api key][] and a unique [django secret key][] (`.env` will
be ignored by git)

Then you have to install some vagrant plugins and build your vagrant box:

```
vagrant plugin install vagrant-vbguest
vagrant plugin install vagrant-hostmanager
vagrant plugin install vagrant-hostsupdater
vagrant up
Expand Down Expand Up @@ -68,5 +77,11 @@ See: docs/local_development



[Vagrant]: https://www.vagrantup.com/downloads.html
[VirtualBox]: https://www.virtualbox.org
[shell provisioner]: http://docs.vagrantup.com/v2/provisioning/shell.html
[ansible provisioner]: http://docs.vagrantup.com/v2/provisioning/ansible.html
[our repository]: https://github.com/pythonkc/pythonkc.com
[meetup api key]: https://secure.meetup.com/meetup_api/key/
[django secret key]: http://www.miniwebtool.com/django-secret-key-generator/

5 changes: 2 additions & 3 deletions pythonkc_site/.env.example
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,3 +1,2 @@
#!/bin/bash
export MEETUP_API_KEY='your-meetup-api-key-here'
export DJANGO_SECRET_KEY='django-secret-key-here'
MEETUP_API_KEY='your-meetup-api-key-here'
DJANGO_SECRET_KEY='django-secret-key-here'