Readme
#
Submission ResourcesThis section is for you (evaluators, judges, advisers, and friends)!!!
- Readme: What you are looking at is the Readme!
- Our product: NUSConnect
- Project Log
- Project Poster
- Project Video
To learn more about acceptance testing and how you can help give us feedback read this section
The following pages are for different aspects of the project. You may navigate to these pages via the sidebar as well. As much as we want our code to speak for ourselves, here are the evidence of our software engineering practices and our efforts.
- User Guide
- Developer Guide
- Our workflow
- DevOps practices
- All things related to testing
- Configuration guide for future contributors
- Timeline
- ProjectLog
- Competitive Analysis
#
Level of AchievementOfficially: Artemis
In our own words:
A software application that we are proud of. One that follows the standard software engineering practices. One that we are not afraid to show you the code. One that we use to remember this summer of NUS CS journey.
#
Project Scope- One sentence version: Jump in the learning loop today!
- A longer descriptive version: A gamified learning management system that is accessible to all and easy to use.
#
Software Engineering PracticesWe hope to build something that is:
- Well functioning
- Well documented
- Well tested
#
Milestone 3 (Refinement)Milestone 3 (Refinement): include bugs squashed, edge features developed, problems encountered, and user testing
#
Bugs squashedView our bugs squashed here
#
User TestingTake a look at our user testing guide here
#
Edge Features DevelopedRead about our edge features and implementation techniques here
#
Problems encounteredRead our problems and issues that we faced along the way here
#
Future DevelopmentView what we plan to do in the future here
#
Milestone 2 (Prototyping)#
Core features developedRead about our core features and implementation techniques here
#
Proposed plan for Milestone 3- Forum:
- We have this mostly completed, so it will just be UI updates and cleaning of
code. There are also some minor enhancements that have yet to be improved
upon:
- Statistics will be shown on the forum homepage
- Reply count will be accurately reflected for each post
- Edit reply input contents have to be cleared on submission
- We have this mostly completed, so it will just be UI updates and cleaning of
code. There are also some minor enhancements that have yet to be improved
upon:
- Quiz:
- We have this mostly completed, so it will just be UI updates and cleaning of
code. There are also some minor enhancements that have yet to be improved
upon:
- Add new question type: lab exercise
- Fix quiz like functionality
- We have this mostly completed, so it will just be UI updates and cleaning of
code. There are also some minor enhancements that have yet to be improved
upon:
- Profile & Dashboard:
- We have this mostly completed, so it will just be UI updates and cleaning of
code. There are also some minor enhancements that have yet to be improved
upon:
- Correct module info and allow enrollment of new modules
- Allow only admins to edit and manage module activity's
- Make new roles for users, teachers and admins
- We have this mostly completed, so it will just be UI updates and cleaning of
code. There are also some minor enhancements that have yet to be improved
upon:
- Wiki:
- We plan on integrating this with the forum so that they are all accessible from one spot.
- Make wiki's functionality more user friendly.
- Badges & Leveling:
- The badges have been made but the ability to get the badges after completion of a quest has yet to be completed and that will be done in the coming weeks.
- Scoreboard system will be touched up and users will be able to see their standing amongst.
- Experience point system is created but has yet to be linked to the exp system to the quest system.
- Testing:
- We are currently in the midst of adding test cases and improving our test coverage. Starting with end-to-end tests and acceptance testing first.
View our timeline logs here
#
Milestone 1 (Ideation)#
Problem motivationFrustrated with the lack of material and information available from previous sem’s and the lack of functionality in the official learning management system LumiNUS, we set out to design a system where students can learn their module content in a more engaging way.
With our background as teaching assistants for the module CS2030(Programming methodology II), we have a burning desire to help our students strive for perfection. We know that learning takes time and continuous effort, but making the process of learning fun and enjoyable will greatly improve students’ performance.
We hope that our project becomes a source of external motivating factors that nudge students to learn the materials by heart. We want students to feel good doing assignments, and be rewarded with virtual points and record their attempts for further analysis. We also want students to try alternative ways of learning, via questions and answers in a forum, via quizzes that are self generated or created by the TAs, and via consolidating their learning into articles to be shared with other module students in the wiki.
If you think: "Yet another contrived combination of Luminous and Coursemology", please read our Competitive Anaylsis section to find out why we think different.
#
Proposed core features- Forum:
- A forum for students to interact with one another, with live chatting, up-voting.
- Responsive and smart design so students have an easy time navigating between posts.
- Wiki:
- Knowledge database for students to see a collection of articles and diagrams that aid in explaining concepts taught in class.
- Create a network of reference materials so that students won’t have to waste time googling
- Quiz:
- Students and TAs can post their own quizzes and look back on past quizzes
- Rich features help to make creating quizzes easy and efficient e.g. support for markdown etc...
View implementation of core features here
#
User StoriesView all our user stories here!
#
Design and planThe design (UI/UX) side of things are yet to be finalized, but we have created multiple design mockups in Figma and also aimed for a minimalistic look for a start.
Refer to our timeline for detailed plan