Bean-Bag

KO | EN

gitlite — search

#python #ai #llm #go #golang #android #nodejs #cli #kubernetes #awesome-list #vue #security #mcp #openai

(★ 9)

Polaris-Bean Bag. Bean Bag is an inventory management system that makes use of image recognition technology to catalog stock items such as second-hand furniture/clothing/books etc. A key feature is that the recognizer can be trained to detect new item types.

Bean-Bag Latest Version Download

Download Latest Version (.zip)

// repository documentation

Was this content helpful?

★ 0 (0 ratings)

<h1>Bean Bag </h1>
<a href="https://ibb.co/MnDrSxX"><img src="https://i.ibb.co/wyNVgFv/beanbag.png" alt="beanbag" border="0"></a><br>
Developed by Polaris for <a href="https://www.agilebridge.co.za/" >Agile Bridge</a></h5> <br>

[![GitHub forks](https://img.shields.io/github/forks/COS301-SE-2021/Bean-Bag?style=flat-round&)](https://github.com/COS301-SE-2021/Bean-Bag/network) [![GitHub stars](https://img.shields.io/github/stars/COS301-SE-2021/Bean-Bag?style=flat-round&)](https://github.com/COS301-SE-2021/Bean-Bag/stargazers) [![GitHub issues](https://img.shields.io/github/contributors/COS301-SE-2021/Bean-Bag?style=flat-round&)](https://github.com/COS301-SE-2021/Bean-Bag/contributors)
[![GitHub issues](https://img.shields.io/github/issues/COS301-SE-2021/Bean-Bag?style=flat-round&)](https://github.com/COS301-SE-2021/Bean-Bag/issues)
![Security Headers](https://img.shields.io/security-headers?style=flat-round&url=https%3A%2F%2Fgithub.com%2FCOS301-SE-2021%2FBean-Bag%2F)
![Uptime Robot status](https://img.shields.io/uptimerobot/status/m788271158-bb7bc699e2e1865de72a0c39?style=flat-round&)
![GitHub pull requests](https://img.shields.io/github/issues-pr/COS301-SE-2021/Bean-Bag?style=flat-round&)
![Workflow](https://github.com/COS301-SE-2021/Bean-Bag/actions/workflows/cicd.yml/badge.svg?branch=master)
---

##

<h2>🔵 Table of Contents</h2>

- [Introduction](#intro) <br>
- [The Team](#team)<br>
- [Mentors](#mentors)<br>
- [Technology Stack](#tech)<br>
- [Github Structure](#structure)<br>
- [Deployment](#deploy)<br>
- [Documentation](#D1)<br>
- [Installation](#D1)<br>
- [Testing](#D1)<br>
- [Project Management Tools](#management)<br>
- [Demo Videos](#D2)

---

<a  name="intro"/><h2>🔵 Introduction </h2></a>

Currently, operations such as cataloging items and searching for items are done manually, which can be seen as a detrimental and inefficient approach especially in fast paced business markets or markets where cataloging requires expert input and results in bottlenecks when loading stock into their inventory management systems.
<br><br>
<b>Bean Bag</b> is an inventory management system that utilizes image recognition technology to optimize and bring forth a new approach to automate and accelerate item cataloging.<br>
This application would assist in multiple areas such as:

- the cataloging of secondhand clothing and apparel,

A key feature of Bean Bag is that the recognizer can be trained on new item types thereby providing flexibility and enabling the application to be tailored to the user depending on the type of items the user catalogs into their inventory.

---

<a name="team"/><h2>🔵 The Team</h2></a>
We are team Polaris, a diverse group of students studying at the <a href="https://www.up.ac.za/"> University of Pretoria.</a> <br>
Below is a short overview of the Polaris team developing the <b>Bean Bag </b> project.

> <img align="left" src="https://i.ibb.co/jDRJrLT/circle-cropped.png" alt="drawing" width="90"/></img> <h3> ‎ ‎‎Reno Davids</h3><p><code> ‎ Team Leader, Backend Development</code> </p> 
> [![GitHub](https://img.shields.io/badge/GitHub-100000?style=flat-round&logo=github&logoColor=white)](https://github.com/renodavids) <t/>[![PersonalProfile](https://img.shields.io/badge/ProfilePage-4285F4?style=flat-round&logo&logoColor=white)](https://dreddy97.github.io/) <t/>[![LinkedIn](https://img.shields.io/badge/linked-in-369?style=flat-round&logo=linkedin&logoColor=white)](https://www.linkedin.com/in/reno-davids-661009210/)
>
> - <i> 3rd year BsC Computer Science student</i>
> - <i>Skills </i>- Problem solving, pragmatic and patient.
> - <i>Interests</i> - Music, video games, Survivor and movies.

<br>

> <img align="left" src="https://i.ibb.co/ZW0CRPb/circle-cropped-6.png" alt="drawing" width="90"/></img> <h3> ‎ ‎‎Nada Chraf</h3><p><code> ‎ Frontend and Backend Development </p></code>
 > [![GitHub](https://img.shields.io/badge/GitHub-100000?style=flat-round&logo=github&logoColor=white)](https://github.com/nadacodes) <t/>[![PersonalProfile](https://img.shields.io/badge/ProfilePage-4285F4?style=flat-round&logo&logoColor=white)](https://nadacodes.github.io/) <t/>[![LinkedIn](https://img.shields.io/badge/linked-in-369?style=flat-round&logo=linkedin&logoColor=white)](https://www.linkedin.com/in/nada-chraf-a1314a135/)
>
> - <i> 3rd year BsC Computer Science student</i>
> - <i>Skills </i>-Researching, programming, designing, creative thinking and problem solving.
> - <i>Interests</i> - Philosophy, film, travelling and learning languages.

<br>

> <img align="left" src="https://i.ibb.co/ZStCzCn/circle-cropped-4.png" alt="drawing" width="90"/></img> <h3> ‎ ‎‎Munashe Muganiwa</h3><p><code> ‎ Backend Development</p></code> 
> [![GitHub](https://img.shields.io/badge/GitHub-100000?style=flat-round&logo=github&logoColor=white)](https://github.com/u18030948) <t/>[![PersonalProfile](https://img.shields.io/badge/ProfilePage-4285F4?style=flat-round&logo&logoColor=white)](https://gitusername.github.io/) <t/>[![LinkedIn](https://img.shields.io/badge/linked-in-369?style=flat-round&logo=linkedin&logoColor=white)](https://www.linkedin.com/in/munashe-muganiwa-03b852b4/)
>
> - <i> 3rd year BIT student</i>
> - <i>Skills </i>-Brainstorming, Creative thinking, Mobile App Dev, Programming (HTML, C++, JAVA, SQL, PHP, Node, React, Delphi, Python), Mathematical thinker.
> - <i>Interests</i> - Hiking, philosophy, space exploration, competitive gaming, taekwando.

<br>

> <img align="left" src="https://i.ibb.co/MZ1dygg/circle-cropped-5.png" alt="drawing" width="90"/></img> <h3> ‎ ‎‎Suzel Alberts</h3><p><code> ‎ Backend Development</p></code> 
> [![GitHub](https://img.shields.io/badge/GitHub-100000?style=flat-round&logo=github&logoColor=white)](https://github.com/Suzel-Alberts) <t/>[![PersonalProfile](https://img.shields.io/badge/ProfilePage-4285F4?style=flat-round&logo&logoColor=white)](https://suzel-alberts.github.io/) <t/>[![LinkedIn](https://img.shields.io/badge/linked-in-369?style=flat-round&logo=linkedin&logoColor=white)](https://www.linkedin.com/in/suzel-alberts-1a0009210/)
>
> - <i> 3rd year BsC Computer Science student</i>
> - <i>Skills </i>- Programming (C++, Java, Python, HTML, CSS, JavaScript). <br> A fast learner, adaptable and creative.
> - <i>Interests</i> - Music, history, documentaries and outdoor activities.

<br>

> <img align="left" src="https://i.ibb.co/gSmBwLh/circle-cropped-7.png" alt="drawing" width="90"/></img> <h3> ‎ Sphesihle Mtwa</h3><p><code> ‎ Frontend Development</p></code> 
> [![GitHub](https://img.shields.io/badge/GitHub-100000?style=flat-round&logo=github&logoColor=white)](https://github.com/sphesihlemtwa) <t/>[![PersonalProfile](https://img.shields.io/badge/ProfilePage-4285F4?style=flat-round&logo&logoColor=white)](https://sphesihlemtwa.github.io/) <t/>[![LinkedIn](https://img.shields.io/badge/linked-in-369?style=flat-round&logo=linkedin&logoColor=white)](https://www.linkedin.com/in/sphesihle-mtwa-a33924206/)
>
> - <i> 3rd year BsC Computer Science student</i>
> - <i>Skills </i>- Communication, emotional intelligence and programming.
> - <i>Interests</i> - Music and cooking.

---

<a name="mentors"/><h2>🔵 Mentors</h3></a>
Mentors that guided the Polaris team during the development of the <b>Bean Bag</b> project.

- Lecturer Mentor: Andrew Broekman <br> :email: andrew.broekman@up.ac.za
- Industry Mentor: Vorster Swanepoel <br>:email: vorsters@agilebridge.co.za
- Student Mentor: Anrich Hildebrand <br>:email: anrichh@agilebridge.co.za

---

<a name="tech"/><h2>🔵 Technology Stack</h3></a>
The technologies used to build the <b>Bean Bag </b> system.

<h4>Backend</h4>
<p> <img alt=".Net" src="https://img.shields.io/badge/ASP.NET Core-5.0-5C2D91?style=flat-round&logo=.net&logoColor=white"/> <img alt="C#" src="https://img.shields.io/badge/C%23-%23239120.svg?style=flat-round&logo=c-sharp&logoColor=white"/></p>
<h4>Frontend - Web App</h4>
<p><img alt="HTML5" src="https://img.shields.io/badge/HTML5-%23E34F26.svg?style=flat-round&logo=html5&logoColor=white"/> <img alt="CSS3" src="https://img.shields.io/badge/CSS3-%231572B6.svg?style=flat-round&logo=CSS3&logoColor=white"/> <img alt="JavaScript" src="https://img.shields.io/badge/JavaScript-%23323330.svg?style=flat-round=javascript&logoColor=%23F7DF1E"/> <img alt="Bootstrap" src="https://img.shields.io/badge/Bootstrap-%23563D7C.svg?style=flat-round&logo=bootstrap&logoColor=white"/></p>

<h4>Cloud Services & Deployment</h4>
<img alt="Azure" src="https://img.shields.io/badge/Microsoft_Azure-0089D6?style=flat-round&logo=microsoft-azure&logoColor=white"/>

<h4>Workflow Automation</h4>
<img alt="GitHub Actions" src="https://img.shields.io/badge/Github Actions-%232671E5.svg?style=flat-round&logo=githubactions&logoColor=white"/>

---

<a name="structure"/><h2> 🔵 Github Structure</h3></a>
The Bean Bag project will make use of a mono-repo. All code and assets related to this project will be available in one repo which is the Bean-Bag repository. This ensures all code is compact and easily avaliable from a single source.

<h4  align="center"> Branching Strategy </h4>

master ( build )
    − deploy
      - develop ( build )
            − develop-backend ( build )
                  − develop-backend-module ( build )
                        − feature-backend-module-feature_name
            − develop-frontend ( build )
                 − develop-module ( build )
                       − feature-frontend-module-feature_name

<h4 align="center"> Flow Management </h4>

- <b>master</b> - this branch contains production code. All development code is merged into master in sometime
- <b>deploy</b> - this branch is necessary to act immediately upon an undesired status of master, and to check all code is working perfectly before deploying.
- <b>develop</b>- this branch contains pre-production code.
- <b>develop-backend</b> - this branch contains pre-production backend code.
- <b>develop-module</b>- this branch contains the backend code for specific subsystems/modules in the system. When the features from the backend are complete, they are merged into module-develop.
- <b>feature-backend-module-feature_name</b> - this branch is used to develop new backend features for a specific module.
- <b>feature-frontend-module-feature_name</b> - this branch is used to develop new frontend features for a specific module.
- <b>develop-frontend</b> -this branch contains pre-production front-end code.

---

<a name="install"/><h2> 🔵 Installation</h2></a>
Download the Visual Studio IDE. To download the Visual Studio IDE, <a href="https://visualstudio.microsoft.com/vs/" >click here</a>.

1. Install the required software in your Visual Studio IDE in the "Workloads" window:
        - ASP.NET and web development
        - Azure development
        - Python development
        - Data storage and processing
    2. Clone the Bean-Bag repository into your local directory.
    3. Launch the Bean-Bag.sln file.

---

<a name="testing"/><h2> 🔵 Testing</h2></a>
Testing the <b>Bean Bag</b> system:

1. Open Visual Studio IDE
    2. Click on "Test" in the panel
    3. Open "Test Explorer"

4. Click on the green play button or type in Ctrl+R,T

---

<a name="D1"/><h2> 🔵 Documentation</h3></a>
All neccessary documentation related to the <b> Bean Bag</b> project.

- [Demo 1 | Software Requirements Specification Document](https://drive.google.com/drive/u/1/folders/1aOf_vzdIkNxeur8eyyou5kn9FHSUVCod)
- [Demo 2 | Architectural Document](https://drive.google.com/file/d/1bOr6wew3k5TFKAb9n3qYyJCWyn7ECS1o/view?usp=sharing) 
- [Demo 2 | User Manual](https://www.overleaf.com/read/tmsbffjmsfgc)
- [Demo 2 | Coding Standards](https://www.overleaf.com/read/rgzpwvjjdkwq)
- [Demo 3 | SRS - Architectural Document](https://drive.google.com/drive/folders/1viOpgJCb1BMFE4uqWRd7mbRtuZ_QopCi?usp=sharing)
- [Demo 3 | Technical Installation Guide](https://drive.google.com/drive/folders/1wIohf9eZYhcIg5I41J-6H5kgn2pTL3ek?usp=sharing)
- [Demo 3 | Coding Standards](https://drive.google.com/drive/folders/1zbzHckzp8XXazPNUY-breSOGIq6FTJP_?usp=sharing)
- [Demo 3 | User Manual](https://drive.google.com/drive/folders/1sKaVFBSJpcAiPRj4aYcBBeWGqiULrZZc?usp=sharing)
- [Demo 4 | SRS - Architectural Document](https://drive.google.com/drive/folders/1viOpgJCb1BMFE4uqWRd7mbRtuZ_QopCi?usp=sharing)
- [Demo 4 | User Manual](https://drive.google.com/file/d/1DEWJOlfJuONUFW7U09nfbH32MQKSPop5/view?usp=sharing)
- [Demo 4 | Testing Quality + NFR Testing Document](https://drive.google.com/file/d/1YSbJqINmp59F5J89X0O0x6EUnk8m4fkP/view?usp=sharing)
- [Demo 4 | Coding Standards](https://drive.google.com/drive/folders/1zbzHckzp8XXazPNUY-breSOGIq6FTJP_?usp=sharing)
- [Demo 4 | Technical Installation Guide](https://drive.google.com/drive/folders/1wIohf9eZYhcIg5I41J-6H5kgn2pTL3ek?usp=sharing)
- [Final | SRS - Architectural Document](https://drive.google.com/drive/folders/1viOpgJCb1BMFE4uqWRd7mbRtuZ_QopCi?usp=sharing)
- [Final | User Manual](https://drive.google.com/file/d/14Q0cUebQfMVIXpgK1npbQrM8oZ777ko0/view?usp=sharing)
- [Final | Testing Quality + NFR Testing Document](https://drive.google.com/file/d/1YSbJqINmp59F5J89X0O0x6EUnk8m4fkP/view?usp=sharing)
- [Final | Coding Standards](https://drive.google.com/drive/folders/1zbzHckzp8XXazPNUY-breSOGIq6FTJP_?usp=sharing)
- [Final | Techincal Installation Guide](https://drive.google.com/file/d/1UwDS_34QD0ls2UaQy7_y3nWR6FpcL-1z/view?usp=sharing)
---

<a name="management"/><h2>🔵 Project Management Tools</h3></a>

The project management applications and communication techniques used for the <b>Bean Bag</b> project. We contacted the clients using a team email and had conferences and discussions on Discord as well as MS Teams. Github as well as Jira were used for issuing tickets and backlog grooming.

- [Jira](https://polariscapestone.atlassian.net/jira/software/projects/BB301/boards/1)
- [MS Teams](https://www.microsoft.com/en-za/microsoft-teams/log-in)
- [GitHub](https://github.com/COS301-SE-2021/Bean-Bag/projects)
- [Discord](https://discord.gg/GJvuD5PM)
- :email: polariscapstone301@gmail.com

---

<a name="D2"/><h2>🔵 Demo Videos</h3></a>
Video demonstrations about the progression of the Bean Bag project.

- [Demo Video 1 - 📅 4 June 2021](https://drive.google.com/drive/u/1/folders/18UvquRIEvCKuZyfEESXBXh2mFWG5_VYl)
- [Demo Video 2 - 📅 21 June 2021](https://drive.google.com/file/d/1-rO9bH5BukctFnMlDfORGhOYwjJ4PBqt/view?usp=sharing)
- [Demo Video 3 - 📅 19 August 2021](https://drive.google.com/file/d/1fXkJ_2Vc2-jhoxGDvmL-n-uTO6VBS7DH/view?usp=sharing)
- [Demo Video 4 - 📅 21 September 2021](https://drive.google.com/file/d/1HYmSTjDWBoTX7_znduoPD-hqCYdxcJd3/view?usp=sharing)

---

<a name="deploy"/><h2>🔵 Deployment</h3></a>

We used Azure to deploy our application.<br>
The deployed website can be found at:<br>
https://beanbagpolaris.azurewebsites.net/

Bean-Bag

Bean-Bag Latest Version Download

Today's picks

Was this content helpful?

Recent Feedback

Bean-Bag

Bean-Bag Latest Version Download

Today's picks

Was this content helpful?

Recent Feedback

Download README