Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/coffee-cup/seng299_group3


https://github.com/coffee-cup/seng299_group3

Last synced: 9 days ago
JSON representation

Awesome Lists containing this project

README

        

# Fox-karaoke

This README outlines the details of collaborating on this Ember application.

This is a Karaoke booking system created with Node and Ember. Instructions on how to run the system are shown below.

## Prerequisites

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

* [Git](http://git-scm.com/)
* [Node.js](http://nodejs.org/) (with NPM)
* [Bower](http://bower.io/)
* [Ember CLI](http://www.ember-cli.com/)

## Installation

* `git clone ` this repository
* change into the new directory
* `npm install`
* `bower install`

## Running / Development

The application has 2 components which need to be run
- Ember frontend (the actual html and what the user will see)
- Node API server (what connects with the database and manages data)

#### Ember frontend

* `ember server` Builds and serves app at [http://localhost:7100](http://localhost:7100).
* port can be customized with `ember server --port PORT`

* `ember build` Builds app to dist/ directory

### Node backend

* `cd RESTServer`
* `nodemon`
OR
* `node ./bin/api.js`

This will run the api server at [http://localhost:7000](http://localhost:7000)

The app uses a mongo server hosted on MongoLab

### Further Reading

* [ember.js](http://emberjs.com/)
* [ember-cli](http://www.ember-cli.com/)
* Development Browser Extensions
* [ember inspector for chrome](https://chrome.google.com/webstore/detail/ember-inspector/bmdblncegkenkacieihfhpjfppoconhi)
* [ember inspector for firefox](https://addons.mozilla.org/en-US/firefox/addon/ember-inspector/)
*

### Admin User Testing

*A user needs to be logged in as an Admin in order to disable rooms if they need to be made unbookable for any reason.
- Username: admin
- Password: admin

### Known Issues

- There is currently no indication if the user is banned or not. If they are banned they will only find out after trying to book a room.
- Calendar may become covered up on certain screen sizes. If this happens, decrease or increase browser window until calendar is visible.