TLDR; if you've done this before
git clone https://github.com/mozilla/webmaker.org
cp env.dist .env
grunt dev(Builds front end js. If you aren't working on front end assets you can just do
grunt(validate and compress images)
- Make a pull request against
Please review our contributing guidelines here.
The setup portion of this README assumes you have the following installed:
- Node.js & npm
npm install -g bower
npm install -g grunt-cli
You should also have these Webmaker stack applications running:
- MakeAPI: https://github.com/mozilla/MakeAPI
- Webmaker Login: https://github.com/mozilla/login.webmaker.org
- Clone webmaker.org and enter the directory:
git clone https://github.com/mozilla/webmaker.org && cd webmaker.org
- Install webmaker.org's Node and Bower dependencies:
- Copy the configuration template to its expected location:
cp env.dist .env
.envin your favourite text editor and ensure that your
LOGINAPIenvironment variables are set to the correct values.
PORTcan be any available port.
LOGINAPIshould point to the URL of your running MakeAPI and Webmaker Login service instances.
grunt dev, and open up
http://localhost:7777/in your favourite web browser!
grunt- Validate LESS, beautify and lint JS, compress images as needed. Run before you push.
grunt dev- Run the server and build js files as they are changed
grunt verify- Verify LESS and JS are formatted and lint free. Read only. Used by Travis.
To add a new language simply add a directory with a locale code under the
locale directory with a JSON file(s) for your strings for example:
You also need to make sure you enable the language in your config by changing the value of
export SUPPORTED_LANGS='[ "en", "id-ID" ]'