Bring Developer Site
RAML HTML CSS JavaScript Ruby
Fetching latest commit…
Cannot retrieve the latest commit at this time.
Permalink
Failed to load latest commit information.
_includes Uppdate main api box for Order management and Warehousing Jun 21, 2018
_layouts Updated the tracking documentation. Also convert to use the api-1.0 d… May 24, 2018
_plugins Add support for sorting of api.raml pages Mar 16, 2018
_posts remove unwanted changes package-lock.json file Jul 31, 2018
_sass undo changes to package-lock.json Jul 31, 2018
api update the fuel surcharge link Aug 7, 2018
blog Swap the "older posts"/"newer posts" buttons Apr 10, 2018
css Add initial blog templates Feb 10, 2016
ecommerce Go live messages and link updates to SG docs Mar 17, 2018
edi Added new pdf for label specification and updated URL on EDI pages Jul 10, 2018
files Added new pdf for label specification and updated URL on EDI pages Jul 10, 2018
img Fix rake build, added blog and image Apr 24, 2018
jobs Use the translate attribute on the whole name Jun 1, 2018
js Add jekyll-archives plugin Feb 10, 2016
scripts Convert to json instead of html Jan 30, 2017
.bring_application_id Add .bring_application_id to support deploy script Dec 7, 2015
.editorconfig Add http://editorconfig.org/ Dec 7, 2015
.gitignore Ignore build directories Jan 10, 2018
.ruby-version added foot note for PIP and fixed product code for half pallet and qu… Sep 22, 2017
Gemfile Add jekyll-archives plugin Feb 10, 2016
Gemfile.lock Fix rake build, added blog and image Apr 24, 2018
Jenkinsfile Temporarily disable environment specific auto deploy Aug 7, 2018
LICENSE Add ISC license Dec 8, 2015
README.md Improve read me about how to build and run environment specific. Aug 7, 2018
Rakefile Improve read me about how to build and run environment specific. Aug 7, 2018
_config.yml Updated the tracking documentation. Also convert to use the api-1.0 d… May 24, 2018
bigip.txt Make it nginx-deployable Dec 7, 2015
favicon.ico Add jekyll WIP Dec 7, 2015
index.html Update documentation about SG version 10 being discontinued. Apr 9, 2018
package.json Don't put all of npm in our webapp Jul 6, 2018
yarn.lock Revert "This file is out of sync with dependencies, causing jenkins t… Jul 6, 2018

README.md

Bring Developer

This repository contains the code behind https://developer.bring.com/

Our developer site is based on Jekyll and RAML. Jekyll is a static site generator, and RAML is a a YAML-based modeling language for APIs. We also use the lovely inuitcss CSS framework.

We currently use RAML 0.8 and ePages' RAML parser gem to parse the RAML files, and have a custom Jekyll plugin for converting the RAML files to HTML files.

The plugin reads a RAML->HTML map from config and outputs HTML files accordingly. RAML 0.8 has a couple of quirks, for example it doesn't have support for multiple examples, resulting in neat hacks here and there to string the page together. We're hoping to migrate to the newly launched RAML 1.0 spec soon.

Run locally

Jekyll can serve the site locally and auto-watch for changes:

brew install node
bundle install
bundle exec rake serve

# or if you want to run for a specific environment:
bundle exec rake serve[<env>] # test, qa, or production

This will clean the build, install necessary SASS dependencies and launch the site at http://127.0.0.1:4000/

Release and deploy

Merging will automatically build and deploy to test, QA and production. 💥

You can still build it (populate the _site dir) manually by running

bundle exec rake build

# or if you want to build for a specific environment:
bundle exec rake build[<env>] # test, qa, or production

and then deploy as normal with

b deploy [test|qa|production]