initial

Author: Stuart Romanek

Dockerfile

@@ -0,0 +1,16 @@
+FROM node:6.5.0
+
+# Create app directory
+RUN mkdir -p /app
+WORKDIR /app
+
+# Bundle app source
+COPY . /app
+RUN npm install
+
+# Mount persistent storage
+VOLUME /app/data
+VOLUME /app/public/uploads
+
+EXPOSE 3000
+CMD [ "npm", "start" ]

LICENSE

@@ -0,0 +1,7 @@
+Copyright (c) 2013 P'unk Avenue LLC
+
+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

@@ -1,3 +1,9 @@
-[![Build Status](https://travis-ci.org/punkave/frontend-starter.svg?branch=feature%2Ffonts-mixin-exts)](https://travis-ci.org/punkave/frontend-starter)
+# Apostrophe boilerplate + Gulp starter pack
 
-BrowserSync server spins up on http://localhost:3001/ (proxying port 3000). Although http://localhost:3000/ will work, use http://localhost:3001/ to utilize BrowserSync features like mirroring and CSS injection.
+## This repo serves as a demo configuration for incorporating Gulp.js with ApostropheCMS.
+
+See `gulpfile.babel.js` for how to push your custom assets to the default place Apostrophe is looking for them.
+
+Combination of the following two repositories:
+- https://github.com/apostrophecms/apostrophe-boilerplate
+- https://github.com/punkave/frontend-starter

app.js

@@ -0,0 +1,25 @@
+var path = require('path');
+
+var apos = require('apostrophe')({
+  shortName: 'apostrophe-gulp-starter',
+
+  // See lib/modules for basic project-level configuration of our modules
+  // responsible for serving static assets, managing page templates and
+  // configuring user acounts.
+
+  modules: {
+
+    // Apostrophe module configuration
+
+    // Note: most configuration occurs in the respective
+    // modules' directories. See lib/apostrophe-assets/index.js for an example.
+    // However any modules that are not present by default in Apostrophe must at
+    // least have a minimal configuration here: `moduleName: {}`
+
+    // If a template is not found somewhere else, serve it from the top-level
+    // `views/` folder of the project
+
+    'apostrophe-templates': { viewsFolderFallback: path.join(__dirname, 'views') }
+
+  }
+});

deployment/.gitignore

@@ -0,0 +1,2 @@
+settings
+settings.production

deployment/README

@@ -0,0 +1,9 @@
+This is a deployment folder for use with Stagecoach.
+
+You don't have to use Stagecoach.
+
+It's just a neat solution for deploying node apps.
+
+See:
+
+http://github.com/punkave/stagecoach

deployment/dependencies

@@ -0,0 +1,48 @@
+#!/bin/bash
+
+# Also a good place to ensure any data folders
+# that are *not* supposed to be replaced on every deployment exist
+# and create a symlink to them from the latest deployment directory.
+
+# The real 'data' folder is shared. It lives two levels up and one over
+# (we're in a deployment dir, which is a subdir of 'deployments', which
+# is a subdir of the project's main dir)
+
+HERE=`pwd`
+mkdir -p ../../data
+ln -s ../../data $HERE/data
+
+# We also have a shared uploads folder which is convenient to keep
+# in a separate place so we don't have to have two express.static calls
+
+mkdir -p ../../uploads
+ln -s ../../../uploads $HERE/public/uploads
+
+# Install any dependencies that can't just be rsynced over with
+# the deployment. Example: node apps have npm modules in a
+# node_modules folder. These may contain compiled C++ code that
+# won't work portably from one server to another.
+
+# This script runs after the rsync, but before the 'stop' script,
+# so your app is not down during the npm installation.
+
+# Make sure node_modules exists so npm doesn't go searching
+# up the filesystem tree
+mkdir -p node_modules
+
+# If there is no package.json file then we don't need npm install
+if [ -f './package.json' ]; then
+  # Install npm modules
+  # Use a suitable version of Python
+  # export PYTHON=/usr/bin/python26
+  npm install
+  if [ $? -ne 0 ]; then
+    echo "Error during npm install!"
+    exit 1
+  fi
+fi
+
+node app apostrophe-migrations:migrate --safe
+# Generate new static asset files for this
+# deployment of the app without shutting down
+node app apostrophe:generation

deployment/migrate

@@ -0,0 +1,8 @@
+#!/bin/bash
+
+# Run any necessary database migration tasks that should happen while the
+# site is paused here.
+
+node app apostrophe-migrations:migrate
+
+echo "Site migrated"

deployment/rsync_exclude.txt

@@ -0,0 +1,14 @@
+# List files and folders that shouldn't be deployed (such as data folders and runtime status files) here.
+# In our projects .git and .gitignore are good candidates, also 'data' which contains persistent files
+# that are *not* part of deployment. A good place for things like data/port, data/pid, and any
+# sqlite databases or static web content you may need
+data
+temp
+public/uploads
+public/modules
+public/apos-minified
+.git
+.gitignore
+# We don't deploy these anymore, instead we always 'npm install' to ensure
+# that any compiled C++ modules are built for the right architecture
+node_modules

deployment/settings.example

@@ -0,0 +1,22 @@
+#!/bin/bash
+
+# Settings shared by all targets (staging, production, etc). Usually the
+# shortname of the project (which is also the hostname for the frontend
+# proxy server used for staging sites) and the directory name. For our
+# web apps that use sc-proxy we make sure each is a subdirectory
+# of /opt/stagecoach/apps
+
+PROJECT=apostrophe
+DIR=/opt/stagecoach/apps/$PROJECT
+
+# Adjust the PATH environment variable on the remote host. Here's an example
+# for deploying to MacPorts
+#ADJUST_PATH='export PATH=/opt/local/bin:$PATH'
+
+# ... But you probably won't need to on real servers. I just find it handy for
+# testing parts of stagecoach locally on a Mac. : is an acceptable "no-op" (do-nothing) statement
+ADJUST_PATH=':'
+
+# ssh port. Sensible people leave this set to 22 but it's common to do the
+# "security by obscurity" thing alas
+SSH_PORT=22

deployment/settings.production.example

@@ -0,0 +1,10 @@
+#!/bin/bash
+
+# Settings specific to the 'master' deployment target.
+# USER is the ssh user, SERVER is the ssh host. USER should
+# match the USER setting in /opt/stagecoach/settings on
+# the server
+
+USER=myuser
+SERVER=myserver.com
+

deployment/start

@@ -0,0 +1,59 @@
+#!/bin/bash
+
+# Make the site live again, for instance by tweaking a .htaccess file
+# or starting a node server. In this example we also set up a
+# data/port file so that sc-proxy.js can figure out what port
+# to forward traffic to for this site. The idea is that every
+# folder in /var/webapps represents a separate project with a separate
+# node process, each listening on a specific port, and they all
+# need traffic forwarded from a reverse proxy server on port 80
+
+# Useful for debugging
+#set -x verbose
+
+if [ ! -f "app.js" ]; then
+  echo "I don't see app.js in the current directory."
+  exit 1
+fi
+
+# Assign a port number if we don't yet have one
+
+if [ -f "data/port" ]; then
+  PORT=`cat data/port`
+else
+  # No port set yet for this site. Scan and sort the existing port numbers if any,
+  # grab the highest existing one
+  PORT=`cat ../../../*/data/port 2>/dev/null | sort -n | tail -1`
+  if [ "$PORT" == "" ]; then
+  	echo "First app ever, assigning port 3000"
+  	PORT=3000
+  else
+    # Bash is much nicer than sh! We can do math without tears!
+    let PORT+=1
+  fi
+  echo $PORT > data/port
+  echo "First startup, chose port $PORT for this site"
+fi
+
+# Run the app via 'forever' so that it restarts automatically if it fails
+# Use `pwd` to make sure we have a full path, forever is otherwise easily confused
+# and will stop every server with the same filename
+
+# Use a "for" loop. A classic single-port file will do the
+# right thing, but so will a file with multiple port numbers
+# for load balancing across multiple cores
+for port in $PORT
+do
+  export PORT=$port
+  forever --minUptime=1000 --spinSleepTime=10000 -o data/console.log -e data/error.log start `pwd`/app.js && echo "Site started"
+done
+
+# Run the app without 'forever'. Record the process id so 'stop' can kill it later.
+# We recommend installing 'forever' instead for node apps. For non-node apps this code
+# may be helpful
+#
+# node app.js >> data/console.log 2>&1 &
+# PID=$!
+# echo $PID > data/pid
+#	
+#echo "Site started"

deployment/stop

@@ -0,0 +1,27 @@
+#!/bin/bash
+
+# Shut the site down, for instance by tweaking a .htaccess file to display
+# a 'please wait' notice, or stopping a node server
+
+if [ ! -f "app.js" ]; then
+  echo "I don't see app.js in the current directory."
+  exit 1
+fi
+
+# Stop the node app via 'forever'. You'll get a harmless warning if the app
+# was not already running. Use `pwd` to make sure we have a full path,
+# forever is otherwise easily confused and will stop every server with
+# the same filename
+forever stop `pwd`/app.js && echo "Site stopped"
+
+# Stop the app without 'forever'. We recommend using 'forever' for node apps,
+# but this may be your best bet for non-node apps
+#
+# if [ -f "data/pid" ]; then
+#   kill `cat data/pid`
+#   rm data/pid
+#   echo "Site stopped"
+# else
+#   echo "Site was not running"
+# fi
+

gulpfile.babel.js

@@ -11,7 +11,7 @@ import sass from 'gulp-sass';
 import source from 'vinyl-source-stream';
 
 const src = 'src/';
-const dest = 'public/';
+const dest = 'lib/modules/apostrophe-assets/public/';
 
 const spawn = require('child_process').spawn;
 const bs = browserSync.create();

lib/modules/apostrophe-assets/index.js

@@ -0,0 +1,16 @@
+// This configures the apostrophe-assets module to push a 'site.less'
+// stylesheet by default, and to use jQuery 3.x
+
+module.exports = {
+  jQuery: 3,
+  stylesheets: [
+    {
+      name: 'site'
+    }
+  ],
+  scripts: [
+    {
+      name: 'site'
+    }
+  ]
+};

lib/modules/apostrophe-pages/index.js

@@ -0,0 +1,14 @@
+// This configures the apostrophe-pages module to add a "home" page type to the
+// pages menu
+
+module.exports = {
+  types: [
+    {
+      name: 'home',
+      label: 'Home'
+    }
+
+    // Add more page types here, but make sure you create a corresponding
+    // template in lib/modules/apostrophe-pages/views/pages!
+  ]
+};

lib/modules/apostrophe-pages/views/notFound.html

@@ -0,0 +1,12 @@
+{#
+  Use this template to build out your 404 error pages. Like page templates,
+  it inherits a global layout.
+#}
+
+{% extends "layout.html" %}
+
+{% block title %}404 - Page not found{% endblock %}
+
+{% block main %}
+  We're sorry. We couldn't find the page you're looking for.
+{% endblock %}

lib/modules/apostrophe-pages/views/pages/home.html

@@ -0,0 +1,17 @@
+{#
+  This is an example home page template. It inherits and extends a layout template
+  that lives in the top-level views/ folder for convenience
+#}
+
+{% extends "layout.html" %}
+
+{% block main %}
+  <div class="main-content">
+    <h3>Hello world!
+      {% if not data.user %}
+        <a class="login-link" href="/login">Login</a>
+      {% endif %}
+    </h3>
+    <p>This is a very bare bones Apostrophe project. Now, get to work and make a real website!</p>
+  </div>
+{% endblock %}

lib/modules/apostrophe-templates/views/outerLayout.html

@@ -0,0 +1,8 @@
+{#
+  This file extends Apostrophe's outerLayoutBase template, which we don't recommend
+  overriding directly. Changes in this file, if any, are usually block overrides to
+  modify the outer chrome, outside the main content area of the page. Most of the
+  time you should just edit `layout.html` in the top level `views/` folder.
+#}
+
+{% extends "outerLayoutBase.html" %}

lib/modules/apostrophe-users/index.js

@@ -0,0 +1,15 @@
+// This configures the apostrophe-users module to add an admin-level
+// group by default:
+
+module.exports = {
+  groups: [
+    {
+      title: 'guest',
+      permissions: [ ]
+    },
+    {
+      title: 'admin',
+      permissions: [ 'admin' ]
+    }
+  ]
+};

local.example.js

@@ -0,0 +1,21 @@
+// Settings specific to this server. Change the URL
+// if you are deploying in production. Then copy to
+// data/local.js. That folder is shared by all
+// deployments in our stagecoach recipe
+
+module.exports = {
+  modules: {
+    'apostrophe-assets': {
+      // Set to true for full CSS and JS minify, on staging and production servers
+      // minify: true
+    },
+    // If these are your db settings then you don't need to be explicit. If not
+    // you can uncomment this and get more specific.
+    'apostrophe-db': {
+      // uri: 'mongodb://localhost:27017/apostrophe-sandbox'
+      // There is legacy support for host, port, name, user and password options,
+      // but this is not necessary. They can all go in the uri option like this:
+      // mongodb://user:password@host:port/dbname
+    }
+  }
+};