Skip to content

Commit e4eaa38

Browse files
committed
updated readme to include some info regarding Redis and how to setup a local environment without the need for Vagrant/VirtualBox.
1 parent 3901806 commit e4eaa38

File tree

1 file changed

+34
-2
lines changed

1 file changed

+34
-2
lines changed

README.rst

Lines changed: 34 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -11,10 +11,12 @@ We will be using the following technologies
1111
- `Python 3`_
1212
- Flask_, a microframework
1313
- Jinja2_, a template engine
14+
- Redis_, a key-value store
1415

1516
.. _Flask: http://flask.pocoo.org/docs/
1617
.. _Jinja2: http://jinja.pocoo.org/docs/
1718
.. _Python 3: http://docs.python.org/3/
19+
.. _Redis: http://redis.io/
1820

1921
Getting Started
2022
+++++++++++++++
@@ -52,8 +54,8 @@ about application factories, please check out `this post`_ by `Matt Wright`_.
5254
.. _Matt Wright: https://github.com/mattupstate
5355
.. _this post: http://mattupstate.com/python/2013/06/26/how-i-structure-my-flask-applications.html
5456

55-
Setup
56-
-----
57+
Setup with VirtualBox and Vagrant
58+
---------------------------------
5759

5860
After installing VirtualBox and Vagrant (see above), `fork the code on GitHub`_
5961
and clone it locally by executing the following command, replacing ``USERNAME``
@@ -83,6 +85,36 @@ The site can be accessed in your browser by visiting `localhost:5050`_.
8385
.. _fork the code on GitHub: https://github.com/NYCPython/nycpython.com/fork
8486
.. _localhost:5050: http://localhost:5050
8587

88+
89+
Setup without VirtualBox or Vagrant
90+
-----------------------------------
91+
92+
For users unable to install VirtualBox or Vagrant you can still get a copy running
93+
locally. `Fork the code on GitHub`_ and clone it locally by executing the following command,
94+
replacing ``USERNAME`` with your GitHub username::
95+
96+
$ git clone [email protected]:USERNAME/nycpython.com.git
97+
98+
After doing that, create a virtual environment ``nycpythoncom`` with Python 3 as your default interpreter
99+
and execute the following command to install all the necessary dependencies for this project::
100+
101+
$ pip install -r requirements.txt
102+
103+
Next, we'll need to install Redis before we can run the server. Deactivate your virutal environment and see
104+
the `Redis Quickstart`_ guide for installation instructions.
105+
106+
Once you have Redis installed, reactivate your virtual environment and execute the following commands
107+
to run the nycpython.com server::
108+
109+
$ redis-server &
110+
$ python wsgi.py
111+
112+
The site can be accessed in your browser by visiting `localhost:5050`_.
113+
114+
.. _fork the code on GitHub: https://github.com/NYCPython/nycpython.com/fork
115+
.. _localhost:5050: http://localhost:5050
116+
.. _Redis Quickstart: http://redis.io/topics/quickstart
117+
86118
Settings
87119
--------
88120

0 commit comments

Comments
 (0)