This project was bootstrapped with [Create React App](https://github.com/facebook/create-react-app).
This project aims to have a software system that automatically gathers and summarise all aspects of the software engineering activities of CIS (Computing and Information Systems) Software Projects (COMP90082) developed. This will allow course coordinators to monitor and promptly provide meaningful feedback to teams, improve the quality of processes used in development and software systems developed, thus ensuring software deployment at the end of every project.
Software Projects Subject (COMP90082) is the subject for students to perform necessary Software Engineering practices to successfully build a high-quality software product for real-world clients. To monitor, evaluate, and provide feedback to students, a supervisor will observe the Software Projects activities of a student team through the software development tools used and through student-supervisor meetings. The involved software development tools include a Version Control System (Git, GitHub/BitBucket/GitLab), a Task Management Tool (JIRA/Trello) and a Documentation tool (Confluence). Some processes would be considered to assess students include Software Testing, Code Review, Continuous Integration, and Deployment.
The tools and processes that students use for these projects (as stated in Background) are diverse and are all accessed on different websites/platforms. Currently, supervisors have to manually open each tool to analyse the complete tasks on each of them. It is an inefficient and tedious process, especially if a supervisor monitors more than ten teams. Although some development tools (e.g., JIRA) provide visual summaries of a team's work, the visualisation only shows data from a single activity. Thus, it is difficult and time-consuming for supervisors to offer detailed and insightful feedback to students, especially if a supervisor has more than one team to supervise.
This project aims to have a software system that automatically gathers and summarise all aspects of the software engineering activities of CIS (Computing and Information Systems) Software Projects (COMP90082) developed. This will allow course coordinators to monitor and promptly provide meaningful feedback to teams, improve the quality of processes used in development and software systems developed, thus ensuring software deployment at the end of every project.
The Software Project application is developed by JavaScript in the front-end and Python3 Django framework and MySQL databases in the back-end.
The steps for installing and deploying Software Project easily is as follows:
- install npm, can refer to https://www.npmjs.com/get-npm
- Install the front-end project, in CLI: npm install
- npm start The front-end is now running on hhttp://18.167.74.23:18000/api/v1
- Install Python3.7 and MySQL
- Install all packages needed pip install -r requirements.txt (Do not install another version of packages which can help you miss many unwanted mistakes) If multiple version of python are installed, use python3 and pip3 or python3.x and pip3.x instead.
- Start MySQL server on localhost:3306, and create a database named "sp90013", i.e., run "CREATE DATABASE sp90013;"
- Modify the MySQL username and password config in TeamSPBackend/settings/dev.py and TeamSPBackend/settings/prod.py (don't forget to modify 'DATABASES/default/TEST/PASSWORD' in prod.py)
- Create MySQL tables python manage.py migrate. If the database changes, use command python manage.py makemigrations to update metadata of database, then python manage.py migrate to update database structure.
- Start server python manage.py runserver, the back-end is now running on http://127.0.0.1:8000/
In the project directory, you can run:
Runs the app in the development mode.
Open http://localhost:3000 to view it in the browser.
The page will reload if you make edits.
You will also see any lint errors in the console.
Launches the test runner in the interactive watch mode.
See the section about running tests for more information.
Builds the app for production to the build folder.
It correctly bundles React in production mode and optimizes the build for the best performance.
The build is minified and the filenames include the hashes.
Your app is ready to be deployed!
See the section about deployment for more information.
Note: this is a one-way operation. Once you eject, you can’t go back!
If you aren’t satisfied with the build tool and configuration choices, you can eject at any time. This command will remove the single build dependency from your project.
Instead, it will copy all the configuration files and the transitive dependencies (webpack, Babel, ESLint, etc) right into your project so you have full control over them. All of the commands except eject will still work, but they will point to the copied scripts so you can tweak them. At this point you’re on your own.
You don’t have to ever use eject. The curated feature set is suitable for small and middle deployments, and you shouldn’t feel obligated to use this feature. However we understand that this tool wouldn’t be useful if you couldn’t customize it when you are ready for it.
https://confluence.cis.unimelb.edu.au:8443/display/COMP900822021SM1SP/6.1.0+Database+schema
https://confluence.cis.unimelb.edu.au:8443/display/COMP900822021SM1SP/6.1.1+Subject
https://confluence.cis.unimelb.edu.au:8443/display/COMP900822021SM1SP/6.1.2+Project
https://confluence.cis.unimelb.edu.au:8443/display/COMP900822021SM1SP/6.1.3+Team
https://confluence.cis.unimelb.edu.au:8443/display/COMP900822021SM1SP/6.1.4+Confluence
https://confluence.cis.unimelb.edu.au:8443/display/COMP900822021SM1SP/6.1.5+Jira
https://confluence.cis.unimelb.edu.au:8443/display/COMP900822021SM1SP/6.1.6+Git
https://confluence.cis.unimelb.edu.au:8443/display/COMP900822021SM1SP/6.2.1+Acceptance+Test
https://confluence.cis.unimelb.edu.au:8443/display/COMP900822021SM1SP/6.2.2+Confluence+API+Design
https://confluence.cis.unimelb.edu.au:8443/display/COMP900822021SM1SP/6.2.3+Database+Design
https://confluence.cis.unimelb.edu.au:8443/display/COMP900822021SM1SP/6.2.4+Data+Sample
https://confluence.cis.unimelb.edu.au:8443/display/COMP900822021SM1SP/6.2.6+Workload+Separation
https://confluence.cis.unimelb.edu.au:8443/display/COMP900822021SM1SP/6.3+Sprint+2%3A+API
Digital Prototype Package is able to download via below link:
https://confluence.cis.unimelb.edu.au:8443/display/COMP900822021SM1SP/4+Prototypes
In coordinator homepage: Shows the list of team members and their corresponding projects. A coordinator can Viewing Project, Importing Project and Viewing Specific Imported Project. https://confluence.cis.unimelb.edu.au:8443/display/COMP900822021SM1SP/Design+update+-+Front-end+team#DesignupdateFrontendteam-1.Coordinatorhomepage
As a coordinator, access your home page to view all imported projects.
As a coordinator, select projects that coordinator wants to import. The coordinator can search through the search bar for the project name that he/she wants to import, and then select the project name. The project is automatically loaded into the select project area below, allowing the coordinator to select multiple projects at once. Then click Import button to import multiple items at once. And all imported projects will show the name of the project, Confluence Link, in the table below.
Please note that the subject selection bar are currently not functional.
As a coordinator, click on the specific project name to access the details about that team. Currently, this button is hardcoded to link to team SP's details and will need to be extended in order to view the details of any team.
In process quality page includes statistical and/or graphical summaries on sprint velocity and burndown, documentation on Confluence, code review frequency and coverage and code commits. For software engineering tools include GitHub, JIRA and Confluence. Here is the link to the UI of the process quality page. https://confluence.cis.unimelb.edu.au:8443/display/COMP900822021SM1SP/Design+update+-+Front-end+team#DesignupdateFrontendteam-3.Processquality
In product quality page includes statistical and/or graphical summaries by code analysed tool (TBC) on: Code quality, Test code quality. For Software Engineering tools include Git (Team's choice of GitHub, GitLab or Bitbucket). Here is the link to the UI of the product quality page. https://confluence.cis.unimelb.edu.au:8443/display/COMP900822021SM1SP/Design+update+-+Front-end+team#DesignupdateFrontendteam-4.Productquality
In communication quality page includes statistical and/or graphical summaries on comments from engineering tools which are GitHub, Confluence. Here is the link to the UI of the current communication quality page. https://confluence.cis.unimelb.edu.au:8443/display/COMP900822021SM1SP/Design+update+-+Front-end+team#DesignupdateFrontendteam-5.Communicationquality
In individuals' contribution page includes statistical and/or graphical summaries of every team member's activities which are: task completion on JIRA, Code reviews on Git and Documentation contribution on Confluence. For software engineering tools include Git (Team's choice of GitHub, GitLab or BitBucket), JIRA, and Confluence. Here is the link to the UI of the current individuals' contribution page. https://confluence.cis.unimelb.edu.au:8443/display/COMP900822021SM1SP/Design+update+-+Front-end+team#DesignupdateFrontendteam-6.Individualcontributionpage
As a coordinator, you may update the team configuration by clicking on the 'Configuration' button on the sidebar. Here the URLs for each of the team's tools should be set (currently not implemented). The account names/ emails for each team member's Slack and github accounts must be set in order to access their individual details in the 'Individual Contribution' section. Here is the link to the UI of the current configuration page. https://confluence.cis.unimelb.edu.au:8443/display/COMP900822021SM1SP/Design+update+-+Front-end+team#DesignupdateFrontendteam-7.Configuration
On the Login page, you can log in to the SP project by entering your email address and password. Here is the link to the UI of the current login page. https://confluence.cis.unimelb.edu.au:8443/display/COMP900822021SM1SP/Design+update+-+Front-end+team+S2#DesignupdateFrontendteamS2-8.Loginpage
Sprint 0 API: https://confluence.cis.unimelb.edu.au:8443/display/COMP900822021SM1SP/6.1+Sprint+0%3A+API
Sprint 1 API: https://confluence.cis.unimelb.edu.au:8443/display/COMP900822021SM1SP/6.2+Sprint+1%3A+API
Sprint 2 API: https://confluence.cis.unimelb.edu.au:8443/display/COMP900822021SM1SP/6.3+Sprint+2%3A+API
Relevant file is for API interfaces: src/_services/user.service.js
You can use this Url to call the API http://18.167.74.23:18000/api/v1
Relevant files are: src/CoordinatorPage/CoordinatorHomePage.js & src/CoordinatorPage/CoordinatorHomePage.css & src/CoordinatorPage/ImportProjectPage.js & src/CoordinatorPage/ImportProjectPage.css & src/CoordinatorPage/ProjectList.js
The project list page shows all the projects that the coordinator is responsible for. Details of the project provide the information of confluence link and "Delete" buttons. The homepage also supports importing projects by a search bar.
Relevant files is: src/ProjectPage/ProjectHomePage.js
The form provides student information including student name, student profile, student ID and email address for the project.
Relevant files is: src/ProjectPage/ProcessQualityPage.js
This part helps coordinators to evaluate the process quality of the project through Jira, Confluence, and Github. Different buttons present different charts of the tool, and the selected button is dark to let the user know which platform is on the screen. By clicking on the Github filter, coordinators can make a view of the line chart of commit times over time. Jira filter illustrates the line chart of items on the To-do-list. The confluence filter shows the line chart of the number of pages.
Relevant files is: src/ProjectPage/ProductQualityPage.js
This page helps coordinators to evaluate the product quality based on static code analysis. Includes project name and a list of criteria that measures product quality.
Relevant files is: src/qualityPages/CommunicationQualityPage.js
This page shows the activeness of communication on Confluence and Github. Check the Confluence button, it will show a list of every meeting with meeting time and meeting minutes, the cells of meeting minutes will be links that are able to be clicked. Check the Github card, it will show a line chart of the number of comments over time.
Relevant files are: src/qualityPages/IndividualContributionPage.js & src/qualityPages/IndividualContributionPage.css
This page helps coordinators to see the proportion of individual contribution directly. It has a drop-down option bar that has a list of student names to select. The button group of three platforms represents Github, Jira, and Confluence. Check the drop-down option bars to see every student’s contribution in the three channels. The contribution is shown in a pie chart. The pie chart shows the contribution of the selected student.
Relevant files is: src/ProjectPage/ProjectSettingsPage.js
This page allows the user to check and update the link of Github, Jira. Paste the link of the two channels on this page to get all the information easily on other pages.
Relevant files are: src/LoginRegister/LoginPage.js & src/LoginRegister/RegisterPage.js
This page is the entry page to an SP project that requires user identification and authentication, performed by entering a username which is an email address and password combination.
https://confluence.cis.unimelb.edu.au:8443/display/COMP900822021SM1SP/3.1+Use+Case+Diagram
https://confluence.cis.unimelb.edu.au:8443/display/COMP900822021SM1SP/3.2+Domain+Model
https://confluence.cis.unimelb.edu.au:8443/display/COMP900822021SM1SP/3.3+Process+Diagram
https://confluence.cis.unimelb.edu.au:8443/display/COMP900822021SM1SP/3.4+Communication+Diagram
• Initial GitHub Project created
• Digital Prototype 1.0 Completed
• Digital Prototype 2.0 Completed according to Client’s feedback
• Created Data Sample: JSON format in an API level for each API
• Created configure page
• Communication page UI was finished
• Updated UI and added showing history function for configure page
• Finished project overview page
• Changed layout for Individual Page
• Coordinator homepage completed a part of API connections with backend
• Communication quality page can interact with backend locally
• Coordinator Homepage UI updated
• Product quality completed API connections
• Updated Coordinator Homepage UI
• Updated API code for Individual Contribution Page
• Coordinator Home page removed box shadow
• Modified project homepage
• Coordinator homepage local API deployment
• Project homepage API code completed
• Bug fix communication quality page
• Product quality API unify testing with backend
• Bugfix communication quality page
• Bugfix communication quality page
• Added saving git username and password function
• Changed the context of the column of meeting minutes to clickable URLs
• Completed Sprint 2 communication quality page
• Coordinator Homepage UI added a drawer for showing student information
• Updated API for Configure page
• Added input check
• Added a no_meeting_minutes alert message
• Updated data sample