|
| 1 | +nycpython.com |
| 2 | +============= |
| 3 | + |
| 4 | +The official website of the NYC Python meetup group. |
| 5 | + |
| 6 | +Technologies |
| 7 | +++++++++++++ |
| 8 | + |
| 9 | +We will be using the following technologies |
| 10 | + |
| 11 | +- `Python 3`_ |
| 12 | +- Flask_, a microframework |
| 13 | +- Jinja2_, a template engine |
| 14 | + |
| 15 | +.. _Flask: http://flask.pocoo.org/docs/ |
| 16 | +.. _Jinja2: http://jinja.pocoo.org/docs/ |
| 17 | +.. _Python 3: http://docs.python.org/3/ |
| 18 | + |
| 19 | +Getting Started |
| 20 | ++++++++++++++++ |
| 21 | + |
| 22 | +Here's everything you need to know to get a copy of nycpython.com running |
| 23 | +locally. |
| 24 | + |
| 25 | +What You Need |
| 26 | +------------- |
| 27 | + |
| 28 | +- Git_ |
| 29 | +- `A GitHub account`_ |
| 30 | +- `The code`_ |
| 31 | +- VirtualBox_ |
| 32 | +- Vagrant_ (`docs <http://docs.vagrantup.com/v2/>`_) |
| 33 | + |
| 34 | +.. _Git: http://git-scm.com/downloads |
| 35 | +.. _A GitHub account: https://github.com |
| 36 | +.. _The code: https://github.com/NYCPython/nycpython.com |
| 37 | +.. _Vagrant: http://downloads.vagrantup.com/ |
| 38 | +.. _VirtualBox: https://www.virtualbox.org/wiki/Downloads |
| 39 | + |
| 40 | +Setup |
| 41 | +----- |
| 42 | + |
| 43 | +After installing VirtualBox and Vagrant, `fork the code on GitHub`_ and clone it |
| 44 | +locally by executing the following command, replacing ``USERNAME`` with your |
| 45 | +GitHub username:: |
| 46 | + |
| 47 | + $ git clone [email protected]:USERNAME/nycpython.com.git |
| 48 | + |
| 49 | +After doing that, execute the following command to build your local virtual |
| 50 | +machine:: |
| 51 | + |
| 52 | + $ vagrant up |
| 53 | + |
| 54 | +You can access all of your code locally, but you will need the virtual machine |
| 55 | +to access the server. To access the virtual machine's command line interface, |
| 56 | +execute the following command:: |
| 57 | + |
| 58 | + $ vagrant ssh |
| 59 | + |
| 60 | +To run the nycpython.com server, execute the following commands on the virtual |
| 61 | +machine:: |
| 62 | + |
| 63 | + $ workon nycpythoncom |
| 64 | + $ python src/server.py |
| 65 | + |
| 66 | +The site can be accessed in your browser by visiting `localhost:5050`_. |
| 67 | + |
| 68 | +.. _fork the code on GitHub: https://github.com/NYCPython/nycpython.com/fork |
| 69 | +.. _localhost:5050: http://localhost:5050 |
| 70 | + |
| 71 | +Meetup API |
| 72 | +---------- |
| 73 | + |
| 74 | +In order to work with the `Meetup API`_, you will first need to create a `Meetup |
| 75 | +API Key`_. |
| 76 | + |
| 77 | +.. _Meetup API: http://www.meetup.com/meetup_api/ |
| 78 | +.. _Meetup API Key: http://www.meetup.com/meetup_api/key/ |
| 79 | + |
| 80 | +Twitter API |
| 81 | +----------- |
| 82 | + |
| 83 | +In order to work with the `Twitter API`_, you will first need to create a |
| 84 | +`Twitter Application`_. Once you have created the application, you will be able |
| 85 | +to retrieve its OAuth settings. |
| 86 | + |
| 87 | +.. _Twitter API: https://dev.twitter.com/docs/api/1.1 |
| 88 | +.. _Twitter Application: https://dev.twitter.com/apps/new |
| 89 | + |
| 90 | +Contributing |
| 91 | +++++++++++++ |
| 92 | + |
| 93 | +A list of issues can be found on GitHub_. Issues are categorized as graphics |
| 94 | +(e.g., logos, banners), front-end (e.g., HTML, CSS, JavaScript), and back-end |
| 95 | +(e.g., Python, API Integration). |
| 96 | + |
| 97 | +Pick one and start hacking away! |
| 98 | + |
| 99 | +.. _GitHub: https://github.com/NYCPython/nycpython.com/issues |
| 100 | + |
0 commit comments