Skip to content

CS2212Team10/NoteHub

Repository files navigation

NoteHub

Synopsis

NoteHub is a note-sharing web application that enables students to post text notes from peers.

  • Users create profiles, sign in, and post text notes.
  • Users can "star" individual notes.
  • Users can create courses and circles within courses.

External Api's and Frameworks used are:

Installation/Run Instructions

  1. Install JDK and a grails framework (The Dependencies should be resolved automatically when it is run)
  2. Open IntelliJ checkout the project from a Version Control (GitHub) using the repository URL: https://github.com/CS2212Team10/NoteHub. Hit 'Clone'.
  3. Click the 'Run' button on IntelliJ, or navigate to the Project's directory using the terminal and type 'grails run-app'

Repository Organization

  • Once you run the project, you will be redirected to the home page.
  • To navigate to the sign up page, click the 'sign up' button.
  • To navigate to the sign in page, of an already-existing account, click the 'sign in' button.

Usage Example

You can view our video demonstration here.

Contributors

  • Backend Team: Cameron Nicolle, Yusra Al-Sharafi, Emma Henriksen-Wills, Yu Guo
  • Frontend Team: Paul Li, Priya Kumaresan, Gabe Keenleyside, Justin Kim
  • TA: Nikita Sokolov