First steps

Initial commit
Steps in order

LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2017 Faris Chebib
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

README.md

@@ -4,20 +4,39 @@ An introduction to django to the tune of git branches.
 
 ## Overview
 
-### Scope / What's not covered
+This repo contains a very basic overview of django 1.11 and utilizes git's tagging to separate steps in basic app creation.
+
+The `README.md`, when viewed on github, should guide through each chapter of the various apps created, in order of complexity. Git tags are used to separate the app into various steps of creation.
+
+### Scope
+
+#### What is covered (in order of complexity)
+
+In the `apps` folder, I have separated the following apps:
+
+1. Basic django html pages `web_page`
+2. Web Apps `web_app`
+3. Django ORM `web_db`
+4. Web / API Endpoints `web_endpoint`
+
+`apps/django_music` is the project setting app. Base URLs are in `apps/django_music/urls.py`
+
+#### What's not covered
 
 * Deployment
 * virtualenvs
 * caching / rate-liming / scaling
-* Databases (other than sqlite3)
+* Databases (other than sqlite3) — we're just focused on ORM usage
+* Static files
+* JavaScript
+
+The instructions were written for a linux development machine.
 
 ## 0. First Steps
 
-1. Install Python
+1. Install Python & Git
 2. Install virtualenv / pip
-3. `git clone github.com/octaflop/django_music` (or `django-admin.py startproject django_music` for projects from scratch).
-4. ```
-mkvirtualenv djmusic && pip install -r requirements.txt && add2virtualenv `pwd/`apps
+3. Clone the repo `git clone github.com/octaflop/django_music` (or `django-admin.py startproject django_music` for projects from scratch).
+4. Spin up a virtual environment ```mkvirtualenv djmusic && pip install -r requirements.txt && add2virtualenv `pwd`/apps
 ```
-
-## 1. A simple web *page*
+5. Ensure things are working by running `./manage.py runserver` and opening a browser to `localhost:8000`