From ae7708fecdff61dd99e3e2b0e3c32b8b017b3cd9 Mon Sep 17 00:00:00 2001 From: Piotr Sarnacki Date: Tue, 10 Feb 2015 07:53:10 +0100 Subject: [PATCH] Update README --- README.md | 56 +++++++++++++------------------------------------------ 1 file changed, 13 insertions(+), 43 deletions(-) diff --git a/README.md b/README.md index 987da786..72e477a0 100644 --- a/README.md +++ b/README.md @@ -2,56 +2,26 @@ [![Build Status](https://travis-ci.org/travis-ci/travis-web.png?branch=master)](https://travis-ci.org/travis-ci/travis-web) ### Running the app +The app is developed using [http://ember-cli.com](Ember CLI). It requires nodejs +with npm installed. + In order to run the app you need to install dependencies with: - bundle install + bower install + npm install -Then you have to run the server, the easiest way to do this is to -use foreman: +Now you can run the server: - bundle exec foreman start + ember serve -Now you can open [localhost:5000](http://localhost:5000) +And open http://localhost:4200 in the browser. -By default it uses the official API at `https://api.travis-ci.org`, but you -can customize the API server URL using: +### Running tests +To run a test suite execute: - API_ENDPOINT="http://localhost:3000/" bundle exec foreman start + ember test -This will run against API run locally. +You can also start an interactive test runner for easier development: -### Compiling assets manually - - bundle exec rakep - ENV=production bundle exec rakep - -### Running the spec suite - -First, start the app (see above). - - bundle exec foreman start - -To run the Ruby specs, run rspec against the spec/ directory: - - bundle exec rspec spec/ - -To run the Jasmine specs, open the spec page: [localhost:5000/spec.html](http://localhost:5000/spec.html) - -### i18n - -Localization for travis-web is managed via [localeapp](http://localeapp.com). -If you are interested in improving the existing localizations or adding -a new locale, please contact us on irc (#travis) and we will set you up. - -Please do **not** edit the YAML files directly. - -Localization data can be synced with the following rake task: - - bundle exec localeapp:update - -This will publish any new keys in en.yml, as well as any missing keys -from your handlebars templates and pull down the latest localizations. - -*note*: You will need to have the localeapp api key exported to -LOCALEAPP_API_KEY + ember test --serve