Перейти к файлу
Pomax 89d04f1eb8 grunt 2016-02-23 13:55:34 -08:00
less remove all local goggle content and redirect to goggles.mozilla.org instead 2016-02-23 12:11:46 -08:00
lib remove all local goggle content and redirect to goggles.mozilla.org instead 2016-02-23 12:11:46 -08:00
locale remove all local goggle content and redirect to goggles.mozilla.org instead 2016-02-23 12:11:46 -08:00
public remove all local goggle content and redirect to goggles.mozilla.org instead 2016-02-23 12:11:46 -08:00
routes remove all local goggle content and redirect to goggles.mozilla.org instead 2016-02-23 12:11:46 -08:00
test removing event guides and forwarding to event guides in events2 2014-03-25 14:39:39 -07:00
views Merge pull request #1435 from Pomax/badgedeprecation 2015-10-19 14:11:25 -07:00
.gitignore Bug 1013444 - Switched angular to html5 mode, moved public_angular into public, added support for /resources and /explore URLs 2014-05-21 18:14:10 -04:00
.jsbeautifyrc Bug 1013444 - Switched angular to html5 mode, moved public_angular into public, added support for /resources and /explore URLs 2014-05-21 18:14:10 -04:00
.jshintrc Bug 1021762 - Update wm.org to use isSuperMentor, not isCollaborator 2014-06-13 14:04:24 -04:00
.no-cache Bug 1049943 - Reland Webmaker Login 3.0 2014-12-15 18:05:54 -05:00
.travis.yml node 0.12? 2016-02-23 12:41:38 -08:00
CONTRIBUTING.md tweaking grunt task naming; adding CONTRIBUTING guidelines 2013-11-07 11:36:30 -08:00
Gruntfile.js grunt 2016-02-23 13:55:34 -08:00
LICENSE.txt Review fixes 2013-04-18 15:43:50 -04:00
Procfile NOBUG Added Procfile 2013-05-06 12:55:42 -04:00
README.md Update readme 2015-07-24 13:37:31 -04:00
angular-i18n-ignoreKeys.json Fix spacing and grunt failing 2015-01-28 10:36:59 -05:00
app.js old linting rules no longer exist 2016-02-23 12:22:16 -08:00
bower.json v1.1.157 2015-09-15 12:01:57 -04:00
cluster.js Revert "Bug 914185 - Switch webmaker.org to use Webmaker Butler r=cade,daleee" 2013-09-11 11:04:27 -04:00
env.dist remove all local goggle content and redirect to goggles.mozilla.org instead 2016-02-23 12:11:46 -08:00
gtf-ignored-keys.json Some goggles landing fixes. 2015-02-06 17:42:04 -05:00
navigation.json upgrade font awesome 2015-03-03 15:41:06 -05:00
package.json less-middleware 2016-02-23 13:00:12 -08:00

README.md

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" ]'