Front end site for Open Assistive built using Hugo and a JAM stack.
Clone or download
Fetching latest commit…
Cannot retrieve the latest commit at this time.
Permalink
Failed to load latest commit information.
archetypes
content
scripts
static
themes
.DS_Store
.gitignore ignore mac files Sep 12, 2017
.gitmodules fix for new theme Jul 17, 2017
.nvmrc
LICENSE
Makefile
README.md updated with correct way of updating submodule Apr 20, 2017
config.toml allowing image_download in more field Oct 23, 2017
items_index.csv
package.json

README.md

OpenATFrontEnd

Build Status

a front-end to OpenAssistive.

To run locally (for the first time)

  1. Install Hugo: https://gohugo.io
  2. git clone https://github.com/openassistive/OpenATFrontEnd.git
  3. cd OpenATFrontend && git submodule update --init --recursive
  4. hugo server --buildDrafts

To run locally (following the inital run)

  1. cd OpenATFrontEnd
  2. hugo server --buildDrafts

To create a new item

  1. hugo new item/name-of-item.md
  2. edit content/item/name-of-item.md

or

  1. cd content/item
  2. touch name-of-item.md
  3. edit name-of-item.md

To export the site to gh-pages (linux/mac)

  1. hugo -d dist --buildDrafts
  2. ./scripts/deploy_locally.sh

To export the site to gh-pages (windows or other)

Not so straightforward.. Basically you have to build the site (to public) and then copy any changes to a checked out version of the gh-pages branch Its what that deploy2.sh does for you automagically. The neatest way in the future is really to make changes directly on github and travis-ci will do the automagic for you

Have a read of:

Notes

  • Note that the theme is Based at https://github.com/openassistive/openat-hugrid
  • The hugo site is a static site generator. Its designed to be run locally and then all /public (or dist - depending on how you want to run the build) is the live static site all in html
  • there is a Makefile and a .travis.yml file in this repo. This allows the site to be automagically built on a commit on travis.