2017 © Pedro Peláez
 

library burthorpe

Burthorpe.com site and API.

image

burthorpe/burthorpe

Burthorpe.com site and API.

  • Saturday, June 14, 2014
  • by iWader
  • Repository
  • 2 Watchers
  • 2 Stars
  • 0 Installations
  • PHP
  • 0 Dependents
  • 0 Suggesters
  • 0 Forks
  • 0 Open issues
  • 1 Versions
  • 0 % Grown

The README.md

Burthorpe.com

Build Status, (*1)

Burthorpe.com is a website that provides a social platform for the users of Runescape as well as an API for developers, (*2)

Getting Started

  • git clone https://github.com/Burthorpe/burthorpe.git
  • vagrant up

Services, by default, are then available at the following locations:, (*3)

  • Web: 192.168.250.10
  • DB: 192.168.251.10

More information on vagrant can be found here., (*4)

Building Assets with Grunt.js

Burthorpe.com uses Grunt.js to manage its assets. To get started with grunt, run the following commands, (*5)

  • npm install -g grunt-cli
  • npm install

Thats it, you're now ready to compile assets using Grunt.js, just use the following command and Grunt will automatically compile assets when a file change is detected., (*6)

grunt watch, (*7)

Notes

  • If you do not wish to use vagrant or other development tools contained in this repo, then you may setup your own development environment. The site root is located at /public., (*8)

  • If you are using your own development environment, don't forget to run composer install --dev., (*9)

  • If you are editing anything in public/assets you must use the Grunt.js task runner., (*10)

  • All images should be contained within public/assets/img/src and built using the grunt imagemin task. Any images within public/assets/img/build should not be committed., (*11)

Copyright (c) 2014 Wade Urry - Released under the MIT license., (*12)

The Versions