Skip to content

The Smart Student Handbook is an advanced note taking application that is aimed towards students to help aid in their note taking experience by making it a collaborative and smart experience. It does this by recommending similar notes and content based off the title, description and tags of the note that the user has opened through the Smart Ass…

Notifications You must be signed in to change notification settings

COS301-SE-2021/Smart-Student-Handbook

Repository files navigation

Smart Student Handbook

Smart Student Handbook pwa Logo

Uptime status

GitHub contributors GitHub issues GitHub closed issues GitHub closed pull requests

Bugs Duplicated Lines (%) Maintainability Rating Lines of Code Reliability Rating Security Rating

Evita CI

Table of Contents

Project Overview

The Smart Student Handbook is an advanced note taking application that is aimed towards students to help aid in their note taking experience by making it a collaborative and smart experience. It does this by recommending similar notes and content based off the title, description and tags of the note that the user has opened through the Smart Assist tool. The Smart Student Handbook also allows students to add collaborators to their notebooks so that multiple students can collaborate in real-time on the same notebook. Each notebook contains it's own chat room so that students who are collaborating can communicate while collaborating. Students are also able to explore, clone and rate notebooks as well as manage their account information.

🖥️ https://smartstudenthandbook.co.za

🎥 Final Demo Video

Desktop Demo GifMobile Demo Gif

Git Structure

  • Monorepo and Git Flow

Branching Strategy

  • master
    • develop
      • feature/frontend/name
      • feature/functions/name
      • hotfix/name

Documentation

Technology Stack

Frontend-End

Angular

Back-End

NestJS Firebase Google Cloud

Testing

Jest GitHub Actions

Other

Docker

Technologies overview

Deployment Model

Project Management

Demo Video Links

Meet the Team

Louw Claassens Luca Prenzler Arno Moller Douglas van Reeuwyk Theo Morkel
Github
LinkedIn
Github
LinkedIn
Github
LinkedIn
Github
LinkedIn
Github
LinkedIn

Contributions

Louw Claassens | u18000402

What I did for Demo 1
  • Implemented The firebase system and the register and login functionality
  • Documentation on the SRS document.
What I did for Demo 2
  • Backend Testing
  • Account, Notebook and User service
What I did for Demo 3
  • Backend Note, Note, Access, Review services
  • Integration Testing
  • Technical Installation Manual
  • Updated SRS
  • Architecture Design
What I did for Demo 4
  • Integration Testing
  • Realtime chat backend
  • Realtime collaboration backend
  • NotebookService backend Refactor

Luca Prenzler | u18002112

What I did for Demo 1
  • Implemented firebase functionality
  • Implemented the SRS document
What I did for Demo 2
  • Testing
  • Comments
What I did for Demo 3
  • Explore Page
  • Backend Notification service
  • User Manual, updated SRS
What I did for Demo 4
  • Unit Testing
  • User Manual
  • Explore Notes
  • Algolia Integration

Arno Moller | u19324058

What I did for Demo 1
  • Implemented the angular frontend
  • Implemented the SRS document
What I did for Demo 2
  • Front end Notebook and notes (create, edit, update, delete)
  • Smart Assist and Notes Panel
What I did for Demo 3
  • Front end notebooks, notes, editor, Notifications, shared with me
  • Entire Notebook feature
  • Mobile view
  • Reset Password
  • Front end testing
  • Technical Installation Manual, Updated SRS
What I did for Demo 4
  • Front end notebooks
  • Real time collaborate
  • Helped to integrate chat function into frontend
  • Helped to integrate smart assist into frontend
  • Swapped Editor.js with Quill.js

Douglas van Reeuwyk | u19049782

What I did for Demo 1
  • Implemented the angular frontend
  • Implemented the SRS document
What I did for Demo 2
  • User Login and Register
  • Angular front end
  • User case diagrams and general SRS
What I did for Demo 3
  • Linting and Angular structure
  • Menu, rooting and auth guards
  • Home, Login, register and Update User
  • Front end testing
  • Coding standard and technical installation manual
What I did for Demo 4
  • Front-End Authentication
  • Improved User Experience and Interface
  • Welcome page
  • Branding
  • SRS update

Theo Morkel | u19002514

I am currently a Computer Science Student at The University of Pretoria

What I did for Demo 1
  • Implemented firebase functionality
  • Implemented SRS documentation
What I did for Demo 2
  • Continuos Integration
  • Account service
What I did for Demo 3
  • Smart Assist AI
  • Backend Account, User Service, email verification and reset password
  • Deployment
What I did for Demo 4
  • Smart Assist Backend
  • Smart Assist Frontend
  • Add User Profile Photo

Contact us

Stakeholders

Computer Science Department

Advance Logo

About

The Smart Student Handbook is an advanced note taking application that is aimed towards students to help aid in their note taking experience by making it a collaborative and smart experience. It does this by recommending similar notes and content based off the title, description and tags of the note that the user has opened through the Smart Ass…

Resources

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published