CMS that drives the Low Fell Running Club website - built using Keystone.js
Clone or download
Fetching latest commit…
Cannot retrieve the latest commit at this time.
Permalink
Failed to load latest commit information.
bower_components
grunt
lib
models
public
routes
spec
templates/views
tools
updates
.bowerrc
.editorconfig
.gitignore
.jsBuildVersion
.jsbeautifyrc
.jshintrc
.modernizrrc.js
.nvmrc
.travis.yml
Gruntfile.js
Procfile
README.md
bower.json
keystone.js
package-lock.json
package.json
webpack.config.js
webpack.records.json

README.md

club-site-admin

This system drives the Low Fell Running Club website. It is built using the Keystone.js CMS/application platform for node.js.

Build Status

Development

Prerequisites

  • Nodejs 4.4.8
  • npm 5.3.0
  • mongodb 2.4+

Build tools

There are various grunt tasks available to aid development:

grunt --help

In addition the test suite can be run via npm test

Building client javascript

This is done via webpack, set to run as an npm script:

npm run webpack
npm run webpack-prod

The production bundles are version controlled - and must be regenerated manually.

Building CSS

  • The site is based on the sass build of Bootstrap, with theming based upon Bootswatch.
  • To regenerate styles: grunt css
  • (Alternatively grunt watch will trigger regeneration on source changes)

Configuration

Email

  • emails sent from the system use the Mailgun service: https://www.mailgun.com/
  • email addresses to receive system-generated messages are configured in Site Config.
  • The .env file (root dir) must contain settings necessary to connect with mailgun, e.g.
MAILGUN_DOMAIN=sandboxd123abc123abc123abc123abc123abc1.mailgun.org
MAILGUN_DOMAIN=nameofmailgundomain.mailgun.org

Image hosting

  • uploaded images are hosted using the Cloudinary service: http://cloudinary.com/
  • The .env file (root dir) must contain settings necessary to connect with cloudinary, e.g.
CLOUDINARY_URL=cloudinary://123412341234123:-ABCABCABCABCABCABCABCABCAB@account

File hosting

  • uploaded files are hosted using Amazon S3 storage: https://aws.amazon.com/s3/
  • A bucket, and access key pair must be pre-configured for the site to use
  • The .env file (root dir) must contain bucket/access key settings required to connect with S3, e.g.
S3_KEY=ABCABCABCABCABCABCAB
S3_SECRET=123412341234123123412341234123abc/+12341
S3_BUCKET=nameofpreconfiguredbucket
S3_REGION=eu-west-1

License

This software is available under the MIT license.