bennyhobart/studly

ReadMe

Setting up development Environment

The following components must be installed in order to get the solution running

• Latest NodeJs
• Yeoman - which is used for scaffolding and workflow, installing yeoman will automatically install grunt and bower

All of the above are available as NPM modules

Running the application locally

After installing the required libraries above browse to pheets and run bower install and npm install to get all dependencies

  bower install && npm install.

After installation run grunt to view development version of the website

grunt serve

To start production ready website

grunt serve:dist

Adding libraries

Bower should be used for adding new libraries when possible, always remember to run bower with the --save-dev tag to update the bower.json file

 bower install libraryname#verion_number --save-dev

Getting node.js dependencies

• There should be a package.json in each of the node.js directories (at this stage, only dataFinders)
• CD to the directory (etc: dataFinders)
• type npm install
• This will look at the package.json file, which will tell npm what it needs to download

###About### Studly is an app that allows students to keep track of which lectures and tutorials that have attended, as well as allowing them easy access to lecture recordings, directions to classes and more.

###Features###

• Nothing, this app hasn't been made yet >_>

###Planned Features###

• Easy timetable management
• Keeping track of what you've been to
• Directions to class
• Ticking things off with GPS

###Technologies###

• Yeoman
• A way to generate a boilerplate AngularJS App with associated unit tests and requirements, like Bootstrap.
• Angular JS
• A Javascript frontend framework
• Sass
• CSS preprocessor that adds functions and variables
• Node.js
• Server backend powered by google's V8 engine (what chrome uses for javascript)
• [Express.js]
• A Server-Side MVC Framework. Works very nicely with Node.js
• Herohu
• A place to deploy our server for free
• Karma Runner
• A javascript test runner for webapps (focussing on angularjs)
• Bootstrap
• A Front-End framework for developing responsive webapps, CSS Framework

studly's Issues

No DB Tech?

Have we decided what database are we going to use?

repo files very disorganised.

Please make a clear distinction that Client is actually in Client. Therefore, the Angular stuff only appears within the Client directory.

I'm gonna wipe all references to Angular in the app directory as there should not be any angular code server side.

That being said, if you're not happy, feel free to revert.

ALSO, when people go to the landing page for the app, they will be visiting a page served from app/index.html. After authentication, Express will redirect the user and serve content from the client directory instead.

Add Subject Stream

Search for and display subjects
Add subject,
Select timetable slots

Server Side API Response Non-Compliant

Error: [$resource:badcfg] Error in resource configuration. Expected response to contain an array but got an object

To Replicate on Client-Side:
GET /api/subject?query=computer

Timetable Page

Nav-Bar, Header and Footers

DB Setup

look into /server/app/app.js

You will find var sessionStore. That's where you hook up the DB. Not sure how to do it with MySQL, but I have samples in MongoDB if you need them.

Login/Register

Why is our repo 50% CSS when it shouldnt be

did someone commit a CSS library or have we really written that much CSS?

Class Page

API 200 Response, but No Data

To replicate problem

http://localhost:9000/api/subject/172

Expected Reponse:
List of classes for Complex Analysis.

Response:
Nothing with 200

Client Side API Requirements

What APIs would you like from Server?

move app/ to server/ whenever you're ready

Hi Ash,

Please move app/ to server/ whenever you're ready to work on the backend. I didn't move it so I wont fuck up whatever you intend to do in server/.

:)