Skip to content

Latest commit

 

History

History
37 lines (27 loc) · 2.58 KB

README.md

File metadata and controls

37 lines (27 loc) · 2.58 KB
Raw

MyHonors (Web)

Travis Build System Coverage Status Code Climate Dependency Status

MyHonors (Web) is a fast, highly performant and beautiful web platform that connects FIU Honors College students, clubs, professors and staff.

Starting Development

  1. Setup the appropriate configuration settings (keys, reference URLs, etc.) at app/.config.js.
  2. npm install to install all of our development dependencies.
  3. npm install bower -g to install Bower globally (if you have not)
  4. bower install to install all of our front-end dependencies.
  5. gulp to run gulp, our task runner that automates things like SASS to CSS compilation, JS minification and uglifying, JSX and/or Typescript to JS compilation.

Technology

MyHonors uses a myriad of web technologies. Some frameworks, tools, and libraries that are used are:

Core Frameworks/Libraries

  • FirebaseJS for storing data in real-time to the Firebase database
  • AngularJS for organizing and abstracting client-side Javascript app logic
  • Bootstrap for the app's interface and design

Build Process

  • Gulp for automating some tasks like running our tests, minification, code-hints and many more
  • Bower for handling our front-end dependencies
  • Jasmine for unit-testing our Javascript code
  • Travis CI for continous-integration, ensuring the quality of our production code

Ground rules

To keep MyHonors highly scalable, it needs to follow a certain discipline in its development environment. Here are some ground rules to follow:

  • Always write your tests before you write your code - Behavior Driven Development!
  • Make sure that tests pass and that you are in sync with the current master branch before making a pull request/merge to the master branch!
  • Follow John Papa's Angular Style Guide!
  • Overview of Javascript, including ES6/ES7!

For more information, do not hesitate to check out the Wiki!