General Overview

Five Dudes Capstone Project.

The rise of large language models like ChatGPT has had a massive impact on the integration of artificial intelligence into everyday life. Music forms an integral part of our lives and we do not always realize this. At Five Dudes, we are excited about the potential to merge artificial intelligence with a service used by billions around the world. Our goal is to harness the use of artificial intelligence to streamline the music listening experience for users everywhere. MoodMix allows us to do just that.

Table of Contents

• General Overview
• Documentation
• Demo Videos
• Git Structure

Team Members

Gerrit Potgieter

Gerrit Potgieter Project Manager, Business Analyst Hi! I’m a final year computer science student looking to further my studies in the field of cyber security! I love exploring the vast spaces in the world of IT and I like to tinker with API's to see what I can achieve with it. I'm most comfortable working middleware and communications within a system.

Rhevan Kruger

Rhevan Kruger Frontend I am a passionate student with a keen eye for detail and a great deal of interest in the world of Computer Science and Software Engineering. I take a great amount of satisfaction in the efficiency of a well-oiled development process and environment. I pride myself on being highly motivated and delivering quality work.I have prior experience in web development, volunteering at RURESA (Rural Rehab SA). Through this process I learned a lot about web-development and found myself thoroughly enjoying the work. I am also well versed in other languages and frameworks some of which will be listed below.

Alex Pretorius

Alex Pretorius Backend , Middleware As a final year Computer Science student who has had experience working in different industry environments. I have a keen interest in Cyber Security, Cloud Security and AI and a good background in different languages like Python, C++ and Java. Along with practical skills I pride myself in delivering a strong work ethic and quality work.

James Hardy

James Hardy Backend , Middleware I possess a solid foundation in various programming languages and web technologies, allowing me to create efficient and innovative solutions. My analytical mindset and keen eye for detail enable me to tackle complex challenges with precision and creativity.Additionally, I am a collaborative team player who values open communication and is committed to delivering high-quality results. My dedication to excellence and passion for technology make me an ideal fit for your project.

Ian van Wyk

Ian van Wyk Services Engineer, something else I am a final year Computer Science student with a deep interest in all things data science and AI. After watching Garry Kasparov vs Deep Blue for the first time, my fascination for computers and AI models started. I was determined to one day be able to implement my own AI models. This is ultimately what led to me studying Computer Science.I am goal-oriented and determined to finish what I start. I try to ensure that the things I do I do to the best of my capabilities and to the highest of quality. My strong work ethic is complemented by robust problem solving skills that I try to apply to all aspects of my life. I am comfortable using the technologies listed below, but I am always eager to expand my repertoire.

Documentation

Requirement Specification

Architecure Specification

Architecture Diagram

Technical Installation Guide

Architecture Diagram

User Manual

Coding Standards

List of Contributions

Project Boards

MoodMix Project Board

MoodMix Burndown Chart

Demo Videos

FiveDudes Demo1 - Video

FiveDudes Demo2 - Video

FiveDudes Demo2 - Presentation

FiveDudes Demo3 - Video

FiveDudes Demo3 - Presentation

Git Organization and Management

Overview

Our Git organization and management strategy is designed to streamline development, ensure code quality, and facilitate smooth releases. This document outlines our branching strategy, the purpose of each branch type, and best practices for collaboration.

Branching Strategy

We follow the Gitflow branching model, which helps manage the project's development and release process effectively. The main branches in our repository are:

• main: Contains production-ready code. Always in a deployable state.
• dev: Integrates all latest development changes. Used for feature integration and testing.
• feature/*: Used for developing new features. Branched off from dev and merged back into dev when complete.
• release/*: Used for preparing a new release. Branched off from dev and merged into both main and dev.
• hotfix/*: Used for critical bug fixes in the production version. Branched off from main and merged into both main and dev.

Main Branch (main)

• Purpose: Contains the stable, production-ready code.
• Usage: Only release and hotfix branches are merged into main.
• Best Practices: Ensure all changes are thoroughly tested and approved before merging into main.

Development Branch (dev)

• Purpose: Integrates all development work. Acts as the primary branch for ongoing development.
• Usage: All feature branches are merged into dev. Developers pull from dev to stay updated with the latest changes.
• Best Practices: Regularly pull from dev to minimize merge conflicts and ensure feature branches are up-to-date.

Feature Branches (feature/*)

• Purpose: Develop new features independently.
• Usage: Branch off from dev to start working on a new feature. Merge back into dev upon feature completion.
• Naming Convention: Use descriptive names, e.g., feature/new-login-page.
• Best Practices: Frequently pull from dev and resolve conflicts locally before merging back.

Release Branches (release/*)

• Purpose: Prepare for a new production release.
• Usage: Branch off from dev when the dev branch has enough completed features for a release. Merge into both main and dev after final testing and minor fixes.
• Naming Convention: Use version numbers, e.g., release/v1.0.
• Best Practices: Ensure all release-critical issues are resolved before merging.

Hotfix Branches (hotfix/*)

• Purpose: Address critical bugs in the production environment.
• Usage: Branch off from main to fix the bug. Merge the fix into both main and dev.
• Naming Convention: Use descriptive names, e.g., hotfix/critical-bug.
• Best Practices: Prioritize resolving the issue quickly and ensure it is tested before merging.

Workflow Example

1. Creating a Feature Branch

   git checkout dev
   git pull origin dev
   git checkout -b feature/new-feature
   

Stakeholder