This Code Corps Ember application powers the front-end website for the Code Corps platform, consuming our Rails JSON API.
We'd love to have you contribute to Code Corps directly!
To do so, please read the guidelines in our CONTRIBUTING.md
.
Then check out some GitHub issues to see where you can help out.
You will need the following things properly installed on your computer.
git clone <repository-url>
this repository- change into the new directory
npm install
bower install
If you're running the Rails API with Docker, then ember-cli-deploy
will automatically watch for changes to your file tree and deploy new revisions to your running redis
instance. Your API running on http://api.lvh.me
will then serve the Ember app's index.html
.
ember server
- Visit your app at http://lvh.me.
If you'd like to run the app without having to set up the server, you can simply hit our remote-development
endpoint.
ember server --environment=remote-development
- Visit your app at http://localhost:4200.
Make use of the many generators for code, try ember help generate
for more details
ember test
ember test --server
ember build
(development)ember build --environment production
(production)
You should refer to our style guide for writing Ember.js, HTML/Handlebars, and SCSS that makes it easier for everyone to work on Code Corps together.
The app uses Circle for continuous integration and deploys automatically to a staging server when merging into develop
and to production when merging into master
.
The Code Corps Ember application uses YUIDoc for documentation. When contributing to the documentation please follow the YUIDoc syntax and our style guide for application specific documenation standards.
npm install -g yuidocjs
yuidoc -c yuidoc.json
The documentation will be generated in the /docs
folder.
- Generate the docs
yuidoc --server [your port of choice]
- Visit
localhost:[your port of choice]
in your browser.