https://github.com/rproenza86/unit-measure-conversion-judge
This is a web application for science teachers. The web app can evaluate unit conversion problems validating the solutions submitted by students.
https://github.com/rproenza86/unit-measure-conversion-judge
ci-cd firebase-hosting github-actions github-projects pwa-app reactjs scrum sdlc
Last synced: about 2 months ago
JSON representation
This is a web application for science teachers. The web app can evaluate unit conversion problems validating the solutions submitted by students.
- Host: GitHub
- URL: https://github.com/rproenza86/unit-measure-conversion-judge
- Owner: rproenza86
- License: gpl-3.0
- Created: 2020-02-05T00:43:14.000Z (over 5 years ago)
- Default Branch: master
- Last Pushed: 2020-04-03T17:17:10.000Z (about 5 years ago)
- Last Synced: 2025-04-12T23:47:32.642Z (about 2 months ago)
- Topics: ci-cd, firebase-hosting, github-actions, github-projects, pwa-app, reactjs, scrum, sdlc
- Language: JavaScript
- Homepage: https://unit-conversion-grader.web.app
- Size: 3.39 MB
- Stars: 0
- Watchers: 4
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# [Unit Measure Conversion Judge](https://unit-conversion-grader.web.app)
> CI/CD powered by [GitHub Actions](https://help.github.com/en/actions/automating-your-workflow-with-github-actions)
| [Continuos Integration(CI)](https://en.wikipedia.org/wiki/Continuous_integration) | [Continuos Deployment(CD)](https://en.wikipedia.org/wiki/Continuous_deployment) |
| :---: | :---: |
|  |  |
## Table of Contents
- [Description](#description)
- [Technical Information](#technical-information)
- [Project management](#project-management)
- [Continuos Delivery](#continuos-delivery)
- [How to use](#how-to-use)
- [Development Operations](#development-operations)
- [Support](#support)
- [License](#license)
## Description
This is a web application for science teachers. The web app can evaluate unit conversion problems validating the solutions submitted by students.
### How it works
Teachers assign students unit-conversion problems on paper worksheets. After students turn in their completed worksheet, the teachers will use this web app to enter the questions and student responses into a computer to be graded.
**Students will convert the following units:**
- **Temperatures:** Kelvin, Celsius, Fahrenheit, and Rankine
- **Volumes**: Liters, Tablespoons, Cubic-inches, Cups, Cubic-feet, and Gallons
> **Note**: The app does not allow conversion between invalid units.
## Technical Information
These project is a *ReactJS, Github and Firebase workshop*. The following technologies and methodologies were used to implement the web application:
- JavaScript Frameworks
- ReactJS and Jest
- Components Libraries
- Material Components for React (MDC React) by Google Material Design team
- Ant Design by Ant Design Group
- React Suite by HYPERS
- Workflow Automation
- [GitHub Actions](https://github.com/rproenza86/unit-measure-conversion-judge/actions)
- Project Management
- [GitHub Projects](https://github.com/rproenza86/unit-measure-conversion-judge/projects/1)
- Software Development Methodology
- Scrum with Kanban influences
## Project Management
Since this is a small project, I used GitHub Projects to manage the project though normally I would use Jira or Rally. Adopted Github organizational tooling to support the SDLC of this project.
### Software Development Methodology
Following a Scrum/Kanban software development methodology, the artifacts were mapped in the following manner:
| Scrum/Kanban | Github |
| :--- | :--- |
| Product Backlog | Github Issues |
| Sprint Backlog | Github Projects (ToDo column) |
| Epics | Github Milestone |
| Story | Github Issue |
| Product Increment | Github Projects Board |
The stories where grouped in Epics, moved into the project board stages from `ToDo` -> `In Progress` -> `Review in Progress` -> `Reviewer Approved` -> `Done`.
Using **Templates** to created User Stories(Github Issues) and Pull Requests so there is an standard structure for each artifact following the best practices and capturing critical information.
### Branching Model
For the development process I used the following branch-based workflow:
1. Branch from master on each new code change request
2. Prefix branch names with `{type of work}/us{issue number}/{description}`
> Ex. `feat/us21/sass-migration`
3. To merge new code additions:
1. One Pull Request is created.
2. Each PR is linked to a given Issue.
3. The PR is validated by running the CI checks.
4. Once passed the checks and coverage threshold, the PR can be merged into the master branch.
4. On code commits into the master branch a CD process is triggered, unit tests are ran and on success, the app is build and deployed to Firebase hosting
5. Once the PR is merged the linked issue is closed automatically and moved to the Done stage
- Created 4 epics/milestones
- The Project board has automation in place to move stories from stages. Ideally I would created one Github Project on this repo for each sprint but I consider it overkill for these small project
## Continuous Delivery Practice
This project use **Continuous Integration** as software development practice to automate the code testing process and it use **Continuous Delivery** to automate the software release process.
To support the CI/CD practices, two automation workloads were created:
1. For CI the [Pull Request Unit Test Check](.github/workflows/pullrequesttest.yml) workload was created.
2. For CD the [Firebase Hosting Deployment](.github/workflows/hostingdeployment.yml) workload was created.
## How to use
### Web application access
The web application is publicly accessible on the next url : https://unit-conversion-grader.web.app
> Short video demo
### Development Operations
To run the web app locally, from the project directory, you can execute the next commands:
#### `npm start`
Runs the app in the development mode.
Open [http://localhost:3000](http://localhost:3000) to view it in the browser.
#### `npm test`
Launches the test runner in the interactive watch mode.
See the section about [running tests](https://facebook.github.io/create-react-app/docs/running-tests) for more information.
#### `npm build`
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](https://facebook.github.io/create-react-app/docs/deployment) for more information.
#### `npm run deploy`
Deploys the latest build to Firebase hosting.
## Support
Create an [Issue](https://github.com/rproenza86/unit-conversion-grader/issues) for any bug or feature request.
Expect a response within 2 business days after submitted your [bug report or feature request](https://github.com/rproenza86/unit-conversion-grader/issues). However, in many cases you'll see a response within 24 hours.
## License
[](https://github.com/rproenza86/events-distributor/blob/master/LICENSE)
- **[GNU General Public License version 3](LICENSE)**
- Copyright 2025 © Raul Proenza