This README outlines the details of collaborating on this Ember/Node.js application hosted freely by Heroku.
You might want to check out the documentation.
Are you new to git? I urge you to complete this interactive git tutorial.
Is Ember new to you? Read the ember-cli Beginner Tutorial
You will need the following things properly installed on your computer.
$ git clone git://github.com/lsu-scheduler/lsu-scheduler.git
$ cd lsu-scheduler
$ npm install
$ bower install
ember server
- Visit your app at http://localhost:4200.
Check out ember-cli, it controls all your developments.
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)
ember server
- Configure your local database in
./models/index.js
node index.js
- Change
lsu-scheduler.herokuapp.com/api
tolocalhost:5000/api
in./app/adapters/application.js
- Visit your app at http://localhost:5000 or http://localhost:4200.
Api calls come from http://localhost:5000/api
node index.js
must be restarted to show changes, it does not auto refresh on file changes
like ember s
does
Check out the project dependencies, they are all documented extremely well.
- 'Run npm -g install yuidocjs'
Check out this syntax reference, to make sure you use the right tags and format
I found it works best when you create a seperate directory to generate your external documentation in and add the files and folders you want external documentation for in that directory. I only do this since I havent figured out how to ignore files.
- Create a Documentation folder
- Copy the files and folder that you want to generate external documentation for into the Documentation folder
- Run yuidoc .
yuidoc will create a directory named 'out' and the html file will be in there
- ember: http://emberjs.com/
- ember-cli: http://www.ember-cli.com/
- Development Browser Extensions
- Getting Started with Node.js on Heroku (https://devcenter.heroku.com/articles/getting-started-with-nodejs#introduction)
- Getting Started with Node.js on Heroku: (https://devcenter.heroku.com/articles/getting-started-with-nodejs#set-up)
- Getting Started with Node.js on Heroku: Provision a database (https://devcenter.heroku.com/articles/getting-started-with-nodejs#provision-a-database)