README.md

MyHonors

Developed for The Honors College at Florida International University.

MyHonors currently features an Events Calendar, Attendance Tracker, Citizenship Tracker, and a complete interface for ARCH. It's fast. It's modern. And it's designed to be 100% responsive for use on phones, tablets, and other mobile devices. To get a taste of what we're planning, see our Roadmap in the Development section below.

We use Firebase to handle real-time data from the backend and AngularJS--an amazing Javascript framework from Google--to power the frontend. Our HTML & CSS code is based on Twitter Bootstrap.

Installation

All necessary files are already included in the repository, so you can get started with just a few steps. Note that we are assuming you use LDAP for authentication and already have an account with Firebase.

1. Download or clone the MyHonors repository and upload the files to your webserver.
2. Rename auth/auth.sample.php to auth/auth.php. Edit the file with the appropriate config settings.
3. Rename application/config.sample.php to application/config.php.
4. If you haven't already, install LDAP support for your server (e.g. apt-get install php5-ldap).
5. That's it! Login with your LDAP username/password and have fun.

Development

###Roadmap

Version		Description
0.x		Adding existing features into repo
	0.1	Linked Authentication with LDAP [DONE]
	0.2	Attendance and Events [DONE]
	0.3	ARCH Registration
	0.4	User Profiles
1.x		Adding Social Features
	1.1	Text posts and comments
	1.2	Media posts (photos, videos, etc.)
	1.3	Private Messages
X.x		Features not assigned to any particular release
	X.x	Automated system messages
	X.x	Email users with updates
	X.x	Add cover charge for events
	X.x	Student portfolios
	X.x	Internship system
	X.x	Course integration
	X.x	User-created groups
	X.x	Integration with main Honors College website
	X.x	Tagging events, posts, profiles, etc.
	X.x	Gamification
	X.x	Analytics system for attendance, activity, etc.