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 diff --git a/README.rst b/README.rst index cc23468..005c8be 100644 --- a/README.rst +++ b/README.rst @@ -101,6 +101,24 @@ The last step is to create an event:: Activate the event [n]: + +Front-End Dependencites +======================= +For those using docker, you can skip this part. + +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 ======================== @@ -112,7 +130,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 @@ -125,3 +143,7 @@ management command. .. _pyenv: https://github.com/yyuu/pyenv .. _pyenv-virtualenvwrapper: https://github.com/yyuu/pyenv-virtualenvwrapper .. _virtualenvwrapper: https://virtualenvwrapper.rtfd.org +.. _Node.js: http://nodejs.org +.. _bower: http://bower.io +.. _Bundler: http://bundler.io/ +.. _Ruby 1.9+: https://www.ruby-lang.org/ diff --git a/pygotham/frontend/static/README.md b/pygotham/frontend/static/README.md deleted file mode 100644 index 9afdd93..0000000 --- a/pygotham/frontend/static/README.md +++ /dev/null @@ -1,29 +0,0 @@ -# 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 -```