Updated 9/June/2023; version 4; sprint4
Game of Ethics is an interactive game aimed at investigating how decisions made in the process of designing a plane affect the final outcome. Five players take on different roles: Executive, Developer, Pilot, Engineer, and FAA. The game consists of two phases: answering personal questions separately, followed by a group discussion. The final outcome is determined based on the choices made by the players.
The game is now hosting in unimelb AWS. You can also access the game through: 3.26.198.126:8000
โโโ docs/ # Documentation files (organized into subfolders)
โโโ src/ # Source code for the Vue.js frontend and backend
โโโ tests/ # User/system tests
โโโ prototypes/ # Prototypes
โ โโโ low_fidelity/ # Low fidelity prototypes (screens, mockups, etc.)
โ โโโ high_fidelity/ # High fidelity prototypes (screens, source files, etc.)
โโโ ui/ # UI assets (icons, fonts, backgrounds, etc.)
โโโ data_samples/ # Data samples necessary to simulate/demonstrate the prototype
โโโ README.md # This file (updated regularly with project information)
Our team maintains separate branches for frontend and backend development (including the database). Each branch contains the latest sprint's original version, enabling developers to pull and push updates during development. Additionally, we have a testing branch for the upcoming sprint, which will replace the main branch after passing all tests. For specific issues, dedicated branches are created to facilitate pull requests and address each problem individually.
โโโ main # Main branch (stable version)
โโโ frontend_sprint_x # Frontend branch for the current sprint
โโโ backend_sprint_x # Backend branch for the current sprint (including database)
โโโ testing_sprint_y # Testing branch for the next sprint
โโโ issue_xx # Issue-specific branches
To get started with the project, follow these steps:
- Clone the repository:
git clone https://github.com/your-username/game-of-ethics.git
- Navigate to the
src
folder:cd game-of-ethics/src
- Install the dependencies:
npm install
- Start the development server:
npm run serve
(for the frontend) andnpm run start
(for the backend)
The frontend server should be running at http://localhost:8080
and the backend server at http://localhost:3000
.
All project documentation can be found in the docs
folder. This includes background information, client goals, motivation, personas, user stories, use cases, and more.
Tests can be found in the tests
folder. To run the tests, navigate to the tests
folder and run the test script: npm test
.
Low fidelity and high fidelity prototypes can be found in the prototypes
folder. These include screen designs, mockups, source files, and other visual representations of the application.
All UI assets, such as icons, fonts, and backgrounds, can be found in the ui
folder.
Data samples necessary for simulating and demonstrating the prototype can be found in the data_samples
folder.
๐ This release represents the completion of Sprint 4 in our project, building upon the foundation established in the previous release. The key achievements of this release are as follows:
1๏ธโฃ This is the last sprint. In this sprint, we documented all necessary files (Confluence, README, Trello Kanban), create a full game demo and ensure all checklists were fulfilled.
๐ This release represents the completion of Sprint 3 in our project, building upon the foundation established in the previous release. we continue to improve our product, providing more value to our users and maintaining a high standard of quality in our development process. The key achievements of this release are as follows:
1๏ธโฃ Sprint2-Feedback Improvements:
- Consider the duration of iterations, speed, priority, project size and other conditions;
- provide explanations for project deployment and future implementation plans.
2๏ธโฃ In our most recent sprint, we have accomplished significant tasks prioritized based on urgency and importance. Below are the key highlights:
- Implemented New Admin Page: We have successfully developed a new feature, an admin page that allows tutors to provide immediate feedback to students, expanding our communication capabilities.
- AWS Development: Progress has been made in developing our product on AWS, significantly enhancing our scalability and reliability.
- UI Improvements: Our team has completed a set of comprehensive UI enhancements, including the addition of a collapse functionality, text color classification, and a redesign of formatting. This will lead to a more intuitive and pleasant user experience.
- Role-Based Data Testing: Rigorous testing was conducted to ensure each role receives the correct corresponding dataset, strengthening the integrity of our system.
- Bug Fixes and Updates: We resolved an issue with the getRoundLevel() function and updated the product backlog in accordance with sprint 3 review.
๐ This release represents the completion of Sprint 2 in our project, building upon the foundation established in the previous release. We have addressed the feedback received from Sprint 1, resolved critical issues, and made the current version of the software accessible to the client. The key achievements of this release are as follows:
1๏ธโฃ Sprint1-Feedback Improvements: ๐ We have addressed the shortcomings identified in the feedback from Sprint 1, and made adjustments to the following areas:
- Project Background, Client Goals, and Motivation
- Character Roles
- Development Environment
- Project Plan
- Iteration Planning
2๏ธโฃ Resolving Critical Issues: ๐ง We identified and resolved 4 out of the 7 major issues that were impacting the gameplay experience:
- Is01: Eliminated duplicate code segments to prevent missed updates
- Is03: Adjusted the backend structure of questions and options
- Is05: Revised the game's rejoin mechanism
- Is07: Resolved server overload to prevent disconnection and game freezing 3๏ธโฃ Client Access to Current Software Version: ๐ผ The client can now access the current version of the software by running the Sprint 2 release code and viewing the demo video. This provides them with an opportunity to evaluate the progress made during this sprint.
๐ This release marks the baseline for our project, combining the documentation from Sprint 1 and the source code inherited from the previous semester. It serves as a starting point for our team's development efforts moving forward. The key components included in this release are as follows:
1๏ธโฃ Sprint 1 Documentation: ๐ The documentation covers the objectives, user stories, and tasks planned for Sprint 1. It also includes the initial project plan, team roles and responsibilities, and a rough timeline for future sprints.
2๏ธโฃ Previous Semester's Source Code: ๐ป This release incorporates the source code from the previous semester, which serves as the foundation for our current project. It contains the initial implementation of the core features, along with some preliminary tests and bug fixes.
https://trello.com/b/zp90iq8B/sprint-3-2-may-31-may
https://confluence.cis.unimelb.edu.au:8443/display/COMP900822023SM1GERedBack/Home
Many Thanks to :
- Our Supervisor Stephanie Brook and,
- Our Client Dr Mauro Mello JR
Our Team: