Merge pull request #280 from LibCrowds/dev

v1.0.0-beta.1

.gitignore

@@ -10,3 +10,4 @@ selenium-debug.log
 src/siteConfig.js
 src/custom/*
 deploy-key
+_book/*

README.md

@@ -1,162 +1,12 @@
 # vue-pybossa-frontend
 
-[![forthebadge](http://forthebadge.com/images/badges/gluten-free.svg)](http://forthebadge.com)
-[![forthebadge](http://forthebadge.com/images/badges/built-with-science.svg)](http://forthebadge.com)
+[![Build Status](https://travis-ci.org/LibCrowds/vue-pybossa-frontend.svg?branch=master)](https://travis-ci.org/LibCrowds/vue-pybossa-frontend)
+[![DOI](https://zenodo.org/badge/92406558.svg)](https://zenodo.org/badge/latestdoi/92406558)
 
 > A Vue.js frontend for PyBossa (>=2.6.1).
 
-This frontend to PyBossa is a little different in that meta-categories can be
-defined to more easily group together large groups of similar projects. For
-example, on the [LibCrowds](www.libcrowds.com) site we define a meta-category for
-two of our major projects, *Convert-a-Card* and *In the Spotlight*.
-
-Each meta-category is presented as if it were a separate site (with it's own
-landing, about and data pages etc.) yet only requires a single PyBossa backend.
-A core page provides routes into each meta-category site, along with the
-statistics, admin and project configuration pages.
-
-## Installing
-
-Install [Node.js >=5.0.0](https://nodejs.org/en/), then:
-
-``` bash
-# install dependencies
-npm install
-```
-
-## Configuring
-
-Site settings can be found in [src/siteConfig.js.tmpl](src/siteConfig.js.tmpl).
-To use this theme you will need to make a copy of the settings file and edit locally.
-
-``` bash
-# create local configuration file
-cp src/siteConfig.js.tmpl src/siteConfig.js
-```
-
-On your PyBossa server, you will need to update the `CORS_RESOURCES` settings
-to allow requests from vue-pybossa-frontend. Something like this (modify
-origins according to your environement):
-
-``` python
-CORS_RESOURCES = {
-  r"/*": {
-    "origins": [
-      "http://127.0.0.1:8080"
-    ],
-    "allow_headers": [
-      'Content-Type',
-      'Authorization',
-      'X-CSRFToken'
-    ],
-    "supports_credentials": True
-  }
-}
-```
-
-For a full list of options see the
-[Flask-CORS documentation](https://flask-cors.readthedocs.io/en/latest/).
-
-
-## Building
-
-``` bash
-# build for production with minification
-npm run build
-
-# build for production and view the bundle analyzer report
-npm run build --report
-```
-
-## Testing
-
-``` bash
-# run unit tests
-npm unit
-
-# run e2e tests
-npm run e2e
-
-# run all tests
-npm test
-```
-
-## Developing
-
-Start up a local PyBossa instance using the default settings, then:
+Configurable PyBossa frontend with a microsite-based structure; as used by LibCrowds:
 
-``` bash
-# serve with hot reload at 127.0.0.1:8080
-npm run dev
-```
+[![Example of vue-pybossa-frontend](./docs/assets/site-homepage.png?raw=true "Example of vue-pybossa-frontend")](https://www.libcrowds.com)
 
-Note that for cookies to be read properly you must access the website at
-127.0.0.1:8080, rather than localhost:8080.
-
-# Deploying
-
-We're running a continuous deployment process to push vue-pybossa-frontend
-updates out to all LibCrowds servers that use it. To configure a new server:
-
-``` bash
-# install node and npm
-sudo apt-get install python-software-properties
-curl -sL https://deb.nodesource.com/setup_8.x | sudo -E bash -
-sudo apt-get install nodejs
-
-# install nginx
-sudo apt-get install nginx
-
-# remove default nginx config
-sudo rm /etc/nginx/sites-available/default
-
-# create nginx config (copy /contrib/frontend)
-vim /etc/nginx/sites-available/frontend
-
-# enable nginx config
-sudo ln -s /etc/nginx/sites-available/frontend /etc/nginx/sites-enabled/frontend
-
-# restart nginx
-sudo service nginx restart
-
-# create an empty repo
-mkdir -p /var/www/deployment/.git
-cd /var/www/deployment/.git
-git init --bare
-
-# create an empty directory for deployments
-mkdir /var/www/frontend
-
-# create a post-receive hook (copy /contrib/post-receive)
-cd hooks
-vim post-receive
-
-# make the script executable
-chmod +x /var/www/deployment/.git/hooks/post-receive
-
-# create a user with restricted access
-adduser deploy
-
-# give that user ownership
-chown -R deploy:deploy /var/www/deployment/.git
-chown -R deploy:deploy /var/www/frontend
-
-# switch to that user
-su - deploy
-
-# create the public key (copy /contrib/deploy-key.pub)
-mkdir ~/.ssh
-vim ~/.ssh/authorized_keys
-
-# restrict permissions
-chmod 700 .ssh
-chmod 600 .ssh/authorized_keys
-```
-
-You can now exit the server and add the site to the `SITES` variable at the
-top of [/bin/deploy.sh](/bin/deploy.sh).
-
-Once the master branch has been updated with this change it will be deployed to
-the new site for the first time.
-
-[![Build Status](https://travis-ci.org/LibCrowds/vue-pybossa-frontend.svg?branch=master)](https://travis-ci.org/LibCrowds/vue-pybossa-frontend)
+[**Read the documentation**](https://libcrowds.gitbooks.io/vue-pybossa-frontend/content/)

bin/README.md

@@ -0,0 +1,63 @@
+# Deployments
+
+We're running a continuous deployment process to push vue-pybossa-frontend
+updates out to all specified LibCrowds servers.
+
+Here are some notes to help configure a new server:
+
+``` bash
+# install node and npm
+sudo apt-get install python-software-properties
+curl -sL https://deb.nodesource.com/setup_8.x | sudo -E bash -
+sudo apt-get install nodejs
+
+# install nginx
+sudo apt-get install nginx
+
+# remove default nginx config
+sudo rm /etc/nginx/sites-available/default
+
+# create nginx config (copy /contrib/frontend)
+vim /etc/nginx/sites-available/frontend
+
+# enable nginx config
+sudo ln -s /etc/nginx/sites-available/frontend /etc/nginx/sites-enabled/frontend
+
+# restart nginx
+sudo service nginx restart
+
+# create an empty repo
+mkdir -p /var/www/deployment/.git
+cd /var/www/deployment/.git
+git init --bare
+
+# create an empty directory for deployments
+mkdir /var/www/frontend
+
+# create a post-receive hook (copy /contrib/post-receive)
+cd hooks
+vim post-receive
+
+# make the script executable
+chmod +x /var/www/deployment/.git/hooks/post-receive
+
+# create a user with restricted access
+adduser deploy
+
+# give that user ownership
+chown -R deploy:deploy /var/www/deployment/.git
+chown -R deploy:deploy /var/www/frontend
+
+# switch to that user
+su - deploy
+
+# create the public key (copy /contrib/deploy-key.pub)
+mkdir ~/.ssh
+vim ~/.ssh/authorized_keys
+
+# restrict permissions
+chmod 700 .ssh
+chmod 600 .ssh/authorized_keys
+```
+
+You can now exit the server and modify [/bin/deploy.sh](/bin/deploy.sh) accordingly.

bin/deploy.sh

@@ -3,7 +3,7 @@
 MASTER='www.libcrowds.com'
 STAGING='dev.libcrowds.com'
 
-if [ "${TRAVIS_BRANCH}" == "master" ] || [ "${TRAVIS_BRANCH}" == "dev" ] ; then
+if [ "${TRAVIS_BRANCH}" == "master" -a "$TRAVIS_PULL_REQUEST" = "false" ] || [ "${TRAVIS_BRANCH}" == "dev" ] ; then
 
   # Configure
   bin/configure.sh

docs/README.md

@@ -0,0 +1,81 @@
+# vue-pybossa-frontend
+
+[![Build Status](https://travis-ci.org/LibCrowds/vue-pybossa-frontend.svg?branch=master)](https://travis-ci.org/LibCrowds/vue-pybossa-frontend)
+[![DOI](https://zenodo.org/badge/92406558.svg)](https://zenodo.org/badge/latestdoi/92406558)
+
+> A Vue.js frontend for PyBossa (>=2.6.1).
+
+This frontend to PyBossa is a little different in that microsites can be defined to more easily group together large groups of similar projects. For example, on the [LibCrowds](www.libcrowds.com) site we define a meta-category for two of our major projects, *Convert-a-Card* and *In the Spotlight*.
+
+Each microsite is presented as if it were a separate site (with it's own landing, about and data pages etc.) yet only requires a single PyBossa backend.
+
+## Installation
+
+Install [Node.js >=5.0.0](https://nodejs.org/en/), then:
+
+``` bash
+# install dependencies
+npm install
+```
+
+## Usage
+
+On your PyBossa server, you will need to update the `CORS_RESOURCES` settings to allow requests from vue-pybossa-frontend. Something like this (modify origins according to your environement):
+
+``` python
+CORS_RESOURCES = {
+  r"/*": {
+    "origins": [
+      "http://127.0.0.1:8080"
+    ],
+    "allow_headers": [
+      'Content-Type',
+      'Authorization',
+      'X-CSRFToken'
+    ],
+    "supports_credentials": True
+  }
+}
+```
+
+For a full list of options see the [Flask-CORS documentation](https://flask-cors.readthedocs.io/en/latest/).
+
+Now, see the [Configuration](configuration.md) section for details of how to configure the site and each microsite.
+
+## Building
+
+To build locally:
+
+``` bash
+# build for production with minification
+npm run build
+
+# build for production and view the bundle analyzer report
+npm run build --report
+```
+
+## Testing
+
+To run tests:
+
+``` bash
+# run unit tests
+npm unit
+
+# run e2e tests
+npm run e2e
+
+# run all tests
+npm test
+```
+
+## Developing
+
+Start up a local PyBossa instance using the default settings, then:
+
+``` bash
+# serve with hot reload at 127.0.0.1:8080
+npm run dev
+```
+
+Note that for cookies to be read properly you must access the website at http://127.0.0.1:8080, rather than http://localhost:8080.

docs/SUMMARY.md

@@ -1 +1,10 @@
+* [Introduction](README.md)
+  * [Installation](README.md#installation)
+  * [Usage](README.md#usage)
+  * [Building](README.md#building)
+  * [Testing](README.md#testing)
+  * [Developing](README.md#developing)
 * [Configuration](configuration.md)
+  * [Directory Structure](configuration.md#directory-structure)
+  * [Site Configuration](configuration.md#site-configuration)
+  * [Microsite Configuration](configuration.md#microsite-configuration)