This repository contains the Ember App that powers the Ember.js Guides.
This app is essentially a static site generator that pulls in the markdown that makes up the Guides Source and outputs three things:
- JSON that contains that content
- an Ember App that is designed to consume that JSON
- static html that is powered by Prember and FastBoot
If that all sounds a bit scary don't worry, thanks to
Ember's Zero Config approach you don't need to worry about any of that to contribute
Welcome and thanks for your help!
First-time contributors are encouraged to choose issues that are labeled "help wanted" or "good for new contributors." If you have questions or want a buddy to pair with, you can join the #-team-learning channel in the Ember Community Slack.
If you were hoping to help with the contents of the Guides instead of the App that powers it then check out the contributing instructions for the Guides Source
Prerequisites for running this app
You will need the following things properly installed on your computer.
git clone https://github.com/ember-learn/guides-app.git
Running / Development
- Visit your app at http://localhost:4200.
- Visit your tests at http://localhost:4200/tests.
Further Reading / Useful Links
- Development Browser Extensions
Local Development alongside the Guides Source
If you are trying to make changes to the Guides App (this repo) and the Guides Source and want see your changes locally you need both repositories on your computer.
git clone git://github.com/ember-learn/guides-app.git git clone git://github.com/ember-learn/guides-source.git cd guides-source npm link cd ../guides-app/ npm i npm link @ember-learn/guides-source npm start