Sphinx By Team Venture
Sphinx is a web based project management catalog and event subscription system.
The goal of this system is to provide visibility and communication about projects
within an organization. Employees will be able to browse through their companies
projects using various search criteria, subscribe to project related events, and
receive periodic updates about their subscribed projects when aspects about them change.
Users of the system will also be able to comment on projects with their feedback and vote
if they like or dislike a project.
To collect the data it operates on, Sphinx will interface with external project management system APIs acquire project metadata and event information. The initial implementation of this system will interact with a custom API for the JIRA project management system (https://www.atlassian.com/software/jira). Once the system has been validated with the Jira integration, interfaces with other project management systems will be considered.
Opensource software utilized:
- [Mongo DB] (http://www.mongodb.org) (Database)
- Play (Web framework)
- Elasticsearch (maybe not)
- Jersey (REST client/server)
- Jackson (JSON Parser)
- Play-Jongo/Jongo (Database Connectors)
##Installing and Running:
- Install mongodb (http://docs.mongodb.org/manual/installation/)
- Download play
- Unzip play
- Run play.bat or ./play in the directory of this project
##Setting Up Your Environment:
No matter what environment you're running, you'll need to grab the play framework from http://www.playframework.com/
- Unzip Play
- Make sure that javac and java are on your Path
- cd to the project (That you totally already cloned)
- run play.bat in this directory
- The terminal command on Windows will be something like ../../path/to/play/play.bat
- On Mac or Linux, you should be able to run the non bat play application instead
- If you are using eclipse, type "eclipse" once the play terminal starts *For other IDEs, check out http://www.playframework.com/documentation/2.1.x/IDE
- Now you should be able to import this as an eclipse project!
###But What About the Libraries? Play uses the sbt build tool for both building all of the internal code and for managing dependencies. When you first compile/run the project, the libraries should all be downloaded by sbt through the maven repositories. If you do run into any problems with the dependencies resolving, please open an issue or contact smy2748@rit.edu so we can look into it.
###Longer Term Setup
- You'll probably want to add play to your path