From 762bd080677d8b2f4deebd527e7e5270df6d0f68 Mon Sep 17 00:00:00 2001 From: Dean Silfen Date: Sun, 31 Jan 2016 14:47:24 -0500 Subject: [PATCH 1/8] Link to front end doc in README.rst --- README.rst | 2 ++ 1 file changed, 2 insertions(+) diff --git a/README.rst b/README.rst index cc23468..d79e661 100644 --- a/README.rst +++ b/README.rst @@ -101,6 +101,7 @@ The last step is to create an event:: Activate the event [n]: +In order to get JavaScript working locally, you must follow the `front end setup instructions here`_. Running the site locally ======================== @@ -125,3 +126,4 @@ management command. .. _pyenv: https://github.com/yyuu/pyenv .. _pyenv-virtualenvwrapper: https://github.com/yyuu/pyenv-virtualenvwrapper .. _virtualenvwrapper: https://virtualenvwrapper.rtfd.org +.. _front end setup instructions here: pygotham/frontend/static/README.md From e23b875f5c545160def921c3712978b3364674e7 Mon Sep 17 00:00:00 2001 From: Dean Silfen Date: Sun, 31 Jan 2016 14:50:12 -0500 Subject: [PATCH 2/8] Update to fix formatting --- README.rst | 1 + 1 file changed, 1 insertion(+) diff --git a/README.rst b/README.rst index d79e661..9a3faa9 100644 --- a/README.rst +++ b/README.rst @@ -102,6 +102,7 @@ The last step is to create an event:: In order to get JavaScript working locally, you must follow the `front end setup instructions here`_. + Running the site locally ======================== From 3b4a74fc9a12b9368b3bdb25322a07159e1fe933 Mon Sep 17 00:00:00 2001 From: Dean Silfen Date: Mon, 1 Feb 2016 00:04:29 -0500 Subject: [PATCH 3/8] Update README.rst to include bower docs --- README.rst | 25 +++++++++++++++++++++++-- pygotham/frontend/static/README.md | 28 ---------------------------- 2 files changed, 23 insertions(+), 30 deletions(-) diff --git a/README.rst b/README.rst index 9a3faa9..5e8a2e3 100644 --- a/README.rst +++ b/README.rst @@ -101,7 +101,25 @@ The last step is to create an event:: Activate the event [n]: -In order to get JavaScript working locally, you must follow the `front end setup instructions here`_. + +Front-End Dependencites +======================= +Requirements + +- `Ruby 1.9+`_ with Bundler_ +- `Node.js`_ with bower_ + + +For SCSS: + - Install dependencies + - navigate to static directory at `pygotham/frontend/static` and run `bundle install` + + - Watch & compile changes by running the command + - `bundle exec compass watch` + +For JavaScript: + - Install dependencies + - navigate to static directory at `pygotham/frontend/static` and run `bower install` Running the site locally ======================== @@ -127,4 +145,7 @@ management command. .. _pyenv: https://github.com/yyuu/pyenv .. _pyenv-virtualenvwrapper: https://github.com/yyuu/pyenv-virtualenvwrapper .. _virtualenvwrapper: https://virtualenvwrapper.rtfd.org -.. _front end setup instructions here: pygotham/frontend/static/README.md +.. _Node.js: http://nodejs.org +.. _bower: http://bower.io +.. _Bundler: http://bundler.io/ +.. _Ruby 1.9+: https://www.ruby-lang.org/ \ No newline at end of file diff --git a/pygotham/frontend/static/README.md b/pygotham/frontend/static/README.md index 9afdd93..8b13789 100644 --- a/pygotham/frontend/static/README.md +++ b/pygotham/frontend/static/README.md @@ -1,29 +1 @@ -# Foundation Compass Template -The easiest way to get started with Foundation + Compass. - -## Requirements - - * Ruby 1.9+ - * [Node.js](http://nodejs.org) - * [compass](http://compass-style.org/): `gem install compass` - * [bower](http://bower.io): `npm install bower -g` - -## Quickstart - - * [Download this starter compass project and unzip it](https://github.com/zurb/foundation-compass-template/archive/master.zip) - * Run `bower install` to install the latest version of Foundation - -Then when you're working on your project, just run the following command: - -```bash -bundle exec compass watch -``` - -## Upgrading - -If you'd like to upgrade to a newer version of Foundation down the road just run: - -```bash -bower update -``` From 372fec489ba342cb6603833e230a83fc917c0869 Mon Sep 17 00:00:00 2001 From: Dean Silfen Date: Mon, 1 Feb 2016 00:06:42 -0500 Subject: [PATCH 4/8] Remove unused README, fix snipped highlighting --- README.rst | 8 ++++---- pygotham/frontend/static/README.md | 1 - 2 files changed, 4 insertions(+), 5 deletions(-) delete mode 100644 pygotham/frontend/static/README.md diff --git a/README.rst b/README.rst index 5e8a2e3..fe9fdc8 100644 --- a/README.rst +++ b/README.rst @@ -112,14 +112,14 @@ Requirements For SCSS: - Install dependencies - - navigate to static directory at `pygotham/frontend/static` and run `bundle install` + - navigate to static directory at ``pygotham/frontend/static`` and run ``bundle install`` - Watch & compile changes by running the command - - `bundle exec compass watch` + - ``bundle exec compass watch`` For JavaScript: - Install dependencies - - navigate to static directory at `pygotham/frontend/static` and run `bower install` + - navigate to static directory at ``pygotham/frontend/static`` and run ``bower install`` Running the site locally ======================== @@ -132,7 +132,7 @@ You should see the PyGotham site at:: http://0.0.0.0:5000// -where ``>`` is the slug of the event created by the ``create_event`` +where ```` is the slug of the event created by the ``create_event`` management command. .. note:: If you're using Docker, Compose will take care of running the site diff --git a/pygotham/frontend/static/README.md b/pygotham/frontend/static/README.md deleted file mode 100644 index 8b13789..0000000 --- a/pygotham/frontend/static/README.md +++ /dev/null @@ -1 +0,0 @@ - From 2dbb7256d2e85c16f003403910d554bde88da34b Mon Sep 17 00:00:00 2001 From: Dean Silfen Date: Mon, 1 Feb 2016 00:07:58 -0500 Subject: [PATCH 5/8] Fix whitespace --- README.rst | 10 +++------- 1 file changed, 3 insertions(+), 7 deletions(-) diff --git a/README.rst b/README.rst index fe9fdc8..33df1fc 100644 --- a/README.rst +++ b/README.rst @@ -111,15 +111,11 @@ Requirements For SCSS: - - Install dependencies - - navigate to static directory at ``pygotham/frontend/static`` and run ``bundle install`` - - - Watch & compile changes by running the command - - ``bundle exec compass watch`` + - Install Dependencies: navigate to static directory at ``pygotham/frontend/static`` and run ``bundle install`` + - Watch & compile changes by running the command - ``bundle exec compass watch`` For JavaScript: - - Install dependencies - - navigate to static directory at ``pygotham/frontend/static`` and run ``bower install`` + - Install Dependencies: navigate to static directory at ``pygotham/frontend/static`` and run ``bower install`` Running the site locally ======================== From c283b05d619b4376f2128356e631aaca19b28b35 Mon Sep 17 00:00:00 2001 From: Dean Silfen Date: Mon, 1 Feb 2016 00:18:11 -0500 Subject: [PATCH 6/8] Update Dockerfile to work with Front End --- Dockerfile | 6 ++++++ 1 file changed, 6 insertions(+) diff --git a/Dockerfile b/Dockerfile index 0c1365d..005d917 100644 --- a/Dockerfile +++ b/Dockerfile @@ -2,4 +2,10 @@ FROM python:3.4.3 WORKDIR /code COPY requirements.txt /code/ RUN python -m pip install -r requirements.txt +RUN apt-get install nodejs +RUN apt-get install ruby +RUN npm install -g bower +RUN gem install bundler ADD . /code +RUN cd /code/pygotham/frontend/static && bower install +RUN cd /code/pygotham/frontend/static && bundle install From 485863f46fb008e1fcd214d75869ea58f0e07c0e Mon Sep 17 00:00:00 2001 From: Dean Silfen Date: Mon, 1 Feb 2016 00:19:10 -0500 Subject: [PATCH 7/8] Add trailing newline to README --- README.rst | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/README.rst b/README.rst index 33df1fc..ec7acef 100644 --- a/README.rst +++ b/README.rst @@ -144,4 +144,4 @@ management command. .. _Node.js: http://nodejs.org .. _bower: http://bower.io .. _Bundler: http://bundler.io/ -.. _Ruby 1.9+: https://www.ruby-lang.org/ \ No newline at end of file +.. _Ruby 1.9+: https://www.ruby-lang.org/ From a2233f037d401e75b5819ce154dd5342213677c8 Mon Sep 17 00:00:00 2001 From: Dean Silfen Date: Mon, 1 Feb 2016 00:20:19 -0500 Subject: [PATCH 8/8] Add note for Docker users --- README.rst | 4 +++- 1 file changed, 3 insertions(+), 1 deletion(-) diff --git a/README.rst b/README.rst index ec7acef..005c8be 100644 --- a/README.rst +++ b/README.rst @@ -104,7 +104,9 @@ The last step is to create an event:: Front-End Dependencites ======================= -Requirements +For those using docker, you can skip this part. + +Requirements: - `Ruby 1.9+`_ with Bundler_ - `Node.js`_ with bower_