Adding contributing section and project structure

README.md

@@ -5,7 +5,7 @@ A boilerplate application for Django web applications.
 
 If you've attented hackathons, you already know how much time can be wasted figuring out what language to pick, which web framework to choose, which APIs to incorporate, and figuring out OAuth authentication. Django Hackathon Starter aims to provide these features out of the box, allowing the team to save hours of time getting these pieces together.
 
-Even if you are not using this for a hackathon, Django Hackathon Starter is sure to save any developer hours or even days of development time and can serve as a learning guide.
+Even if you are not using this for a hackathon, Django Hackathon Starter is sure to save any developer hours or even days of development time and can serve as a learning guide for web developers.
 
 <h4 align="center">Basic Authentication / OAuth Signin </h4>
 
@@ -26,6 +26,8 @@ Table of Contents
 - [Pre-requisites](#pre-requisites)
 - [Getting Started](#getting-started)
 - [Obtaining API Keys](#getting-api-keys)
+- [Project Structure](#project-structure)
+- [Contributing](#contributing)
 - [License](#license)
 
 Features
@@ -36,7 +38,7 @@ Features
 * Basic Authentication with username and password
 * **OAuth 2.0 Authentication** for Github, LinkedIn and Instagram
 * **OAuth 1.0a Authentication** for Twitter and Tumblr
-* API Examples
+* **API Examples**
     * Yelp API
     * Github API
     * Instagram API
@@ -231,6 +233,47 @@ Getting API Keys
 2. After logging in, click on **Me** and then **Account settings** to find the API key 
 3. Within your `settings.py`add `QUANDLAPIKEY` = `Key` 
 
+<hr>
+
+Project Structure
+-----------------
+
+
+| Name                               | Description                                                 |
+| ---------------------------------- |:-----------------------------------------------------------:|
+| **hackathon_starter/hackathon_starter**/settings.py                               | Django settings module containing database and API keys/tokens. |
+| **hackathon_starter/hackathon**/admin.py                                          | Registered models for Django's admin page.        |
+| **hackathon_starter/hackathon**/models.py                                         | Django models and profiles for user login.            |
+| **hackathon_starter/hackathon**/tests.py                                          | Integration tests.                                |
+| **hackathon_starter/hackathon**/urls.py                                           | Django Hackathon Starter URL dispatcher.                          |
+| **hackathon_starter/hackathon**/views.py                                          | Django views file.                     |
+| **hackathon_starter/hackathon**/serializers.py                                    | Allows JSON representation for Django Model fields.                       |
+| **hackathon_starter/hackathon**/forms.py                                          | Basic form fields.                       |
+| **hackathon_starter/hackathon**/static/                                           | Front-end JavaScript / CSS files.                |
+| **hackathon_starter/hackathon**/unittests                                         | Unit tests.                    |
+| **hackathon_starter/hackathon**/scripts/                                          | API Example scripts.                              |
+| **hackathon_starter/hackathon**/scripts/github.py                                 | Script for interacting with Github API.          |
+| **hackathon_starter/hackathon**/scripts/instagram.py                              | Script for interacting with Instagram API.     |
+| **hackathon_starter/hackathon**/scripts/linkedin.py                               | Script for interacting with LinkedIn API.                                |
+| **hackathon_starter/hackathon**/scripts/meetup.py                                 | Script for interacting with Meetup API.                |
+| **hackathon_starter/hackathon**/scripts/nytimes.py                                | Script for interacting with New York Times API.                                    |
+| **hackathon_starter/hackathon**/scripts/quandl.py                                 | Script for interacting with Quandl API.                                    |
+| **hackathon_starter/hackathon**/scripts/scraper.py                                | Basic web scraper for getting sales from Steam.                                              |
+| **hackathon_starter/hackathon**/scripts/steam.py                                  | Script for interacting with Steam API.                                         |
+| **hackathon_starter/hackathon**/scripts/tumblr.py                                 | Script for interacting with Tumblr API.                                      |
+| **hackathon_starter/hackathon**/scripts/twilioapi.py                              | Script for interacting with Twilio API. |
+| **hackathon_starter/hackathon**/scripts/twitter.py                                | Script for interacting with Twitter API. |
+| **hackathon_starter/hackathon**/scripts/yelp.py                                   | Script for interacting with Yelp API. |
+| **hackathon_starter/hackathon**/templates/hackathon/                              | Templates for API examples. |
+| **hackathon_starter/hackathon**/templates/hackathon/base.html                     | Base template, contains navbar. |
+| **hackathon_starter/hackathon**/templates/hackathon/api_examples.html             | Template for API Examples page. |
+
+Contributing
+------------
+
+We welcome contributions of all kinds. If you would like to know what work is needed to be done, check the [issue tracker](https://github.com/DrkSephy/django-hackathon-starter/issues). Before sending a pull request, please open an issue. This project follows the [pep-0008](https://www.python.org/dev/peps/pep-0008/) style guide. 
+
+
 LICENSE
 -------