Name: demo-ember-osf
Owner: Center for Open Science
Description: A scaffold for ember apps that talk to the OSF
Created: 2017-01-25 00:33:38.0
Updated: 2017-06-01 18:09:38.0
Pushed: 2017-08-21 14:29:57.0
Homepage: null
Size: 184
Language: JavaScript
GitHub Committers
User | Most Recent Commit | # Commits |
---|
Other Committers
User | Most Recent Commit | # Commits |
---|
This is a demonstration project that consumes the ember-osf Ember addon, produced by the Center for Open Science.
The focus is on basic scaffolding, incorporating opinionated best practices such as documentation tools, style guide checking, and CI build scripts/ code coverage metrics.
This application is based on Ember 2.8 LTS, yarn, nvm, Sass, and YUIDoc. It applies linters for JS and template style, and incorporates badges and config for health reporting services such as Travis and Coveralls.io.
In the future we may add a dependency on ember-i18n
, depending on goals for this demonstration app.
You will need the following things properly installed on your computer.
git clone https://github.com/abought/demo-ember-osf.git -o upstream
this repositorycd demo-ember-osf
yarn install --pure-lockfile
bower install
ember generate ember-osf
- will generate config/local.yml
; fill in the
required fieldsIf you would like to log errors to Sentry, add SENTRY_DSN
to the correct section of your local.yml
file, and
specify the appropriate configuration string for your server/ project. We encourage remote error logging for all COS
projects.
BACKEND=stage ember server
docker build -t demo-ember-osf . && docker run -p 4200:4200 demo-ember-osf BACKEND=stage ./node_modules/ember-cli/bin/ember serve
Make use of the many generators for code, try ember help generate
for more details
Unit tests can be run as follows:
ember test
ember test --server
To run all tests required for CI, use:
yarn test
Testing with docker:
docker build -t demo-ember-osf . && docker run demo-ember-osf
ember build
(development)ember build --environment production
(production)There are several packages that can enhance your large-scale applications, but are not included in this scaffold:
ember-i18n
(may be added in the future)In the future, we will add: