HTML JavaScript CSS
Latest commit 3a12021 Mar 17, 2016 @cadecairos cadecairos Update README.md
Permalink
Failed to load latest commit information.
less
lib
locale
public
routes
test
views
.gitignore
.jsbeautifyrc
.jshintrc
.no-cache
.travis.yml
CONTRIBUTING.md
Gruntfile.js
LICENSE.txt
Procfile
README.md
angular-i18n-ignoreKeys.json
app.js
bower.json
cluster.js
env.dist
gtf-ignored-keys.json
navigation.json
package.json

README.md

This project is no longer under active development.

Read about why, here: https://blog.webmaker.org/whats-next-for-webmaker-tools

Build Status Dependency Status Code Climate

webmaker.org

TLDR; if you've done this before

####Development

  1. git clone https://github.com/mozilla/webmaker.org
  2. npm install
  3. cp env.dist .env
  4. grunt dev (Builds front end js. If you aren't working on front end assets you can just do node app)

####Submitting PRs

  1. grunt (validate and compress images)
  2. Make a pull request against mozilla/master

##New Contributors

Please review our contributing guidelines here.

Dependencies

The setup portion of this README assumes you have the following installed:

  • Node.js & npm
  • Bower: npm install -g bower
  • grunt-cli: npm install -g grunt-cli

You should also have these Webmaker stack applications running:

Project Setup

  1. Clone webmaker.org and enter the directory: git clone https://github.com/mozilla/webmaker.org && cd webmaker.org
  2. Install webmaker.org's Node and Bower dependencies: npm install
  3. Copy the configuration template to its expected location: cp env.dist .env
  4. Open .env in your favourite text editor and ensure that your PORT, MAKE_ENDPOINT, LOGIN and LOGINAPI environment variables are set to the correct values. PORT can be any available port. MAKE_ENDPOINT, LOGIN and LOGINAPI should point to the URL of your running MakeAPI and Webmaker Login service instances.
  5. Run grunt dev, and open up http://localhost:7777/ in your favourite web browser!

Grunt Tasks

  • 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.

Localization

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: locale/id_ID/strings.json

You also need to make sure you enable the language in your config by changing the value of SUPPORTED_LANGS

  export SUPPORTED_LANGS='[ "en", "id-ID" ]'