Skip to content

lsu-scheduler/lsu-scheduler-api

Repository files navigation

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.

Getting Started

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

Frontend

Prerequisites

You will need the following things properly installed on your computer.

Git

Node.js

Bower

ember-cli

Installation

$ git clone git://github.com/lsu-scheduler/lsu-scheduler.git
$ cd lsu-scheduler
$ npm install
$ bower install

Running / Development

Check out ember-cli, it controls all your developments.

Code Generators

Make use of the many generators for code, try ember help generate for more details

Running Tests

  • ember test
  • ember test --server

Building

  • ember build (development)
  • ember build --environment production (production)

Backend

Running / Development

  • ember server
  • Configure your local database in ./models/index.js
  • node index.js
  • Change lsu-scheduler.herokuapp.com/api to localhost: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.

Documentation

Install Yuidoc

  • 'Run npm -g install yuidocjs'

Write Internal Documentation

Check out this syntax reference, to make sure you use the right tags and format

Generate External Documentation

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

Further Reading / Useful Links

Releases

No releases published

Packages

No packages published

Contributors 4

  •  
  •  
  •  
  •