README.md

springload.github.io

Springload’s hub for open source

Important links

Documentation: see #documentation 📖
Production site
GA production tracking

Installation

Clone the project on your computer, and install Node. This project also uses nvm.

From the command-line:

cd ~/Development/sites/
git clone [email protected]:springload/springload.github.io.git
cd springload.github.io

To install our dependencies:

nvm install
# Then, install all project dependencies.
pip install wrangler
npm install

Working on the project

Everything mentioned in the installation process should already be done.

# Start the server and the development tools.
npm run start
# Builds frontend assets.
npm run build

Adding and upgrading dependencies

This project is shrinkwrapped. Its dependencies are locked down in npm-shrinkwrap.json file. To update them,

1. Use npm run lint:versions to confirm you are using the right node version.
2. Use npm install <package> with --save or --save-dev options to change the dependencies.
3. Check the project still works with the new dependencies / new versions.
4. Run npm run shrinkwrap to regenerate npm-shrinkwrap.json.
5. Commit this file, and push.

Deploying a new version

To production

npm run deploy

Deployment configuration (one-off)

Continuous integration & delivery is done with Travis.

This site is hosted on GitHub Pages. The live site is the repository's master branch.

# Create deploy/production branch
# Create master branch
gem install travis
travis encrypt GH_TOKEN=<GitHub personal access token> --add
# Go to https://travis-ci.org/springload/springload.github.io/settings,
# Build only if .travis.yml is present: On

Documentation

Browser support

Supported browser / device versions:

Browser	Device/OS	Version
Mobile Safari	iOS Phone	latest
Mobile Safari	iOS Tablet	latest
Chrome	Android	latest
IE	Desktop	11
Chrome	Desktop	latest
MS Edge	Desktop	latest
Firefox	Desktop	latest
Safari	OSX	latest

Favicons

To generate new favicons,

1. Go to https://realfavicongenerator.net/
2. Upload your favicon source file as an SVG or PNG with a resolution of at least 512x512.
3. Configure the favicon generation. Use specific images for each platform if relevant.
4. Grab the result files, use ImageOptim to losslessly optimize their size them.
5. Grab the result HTML tags, add it to the core/templates/core/includes/favicons.html file.
6. Make sure the files are served by the server as expected.