To make it easy for you to get started with GitLab, here's a list of recommended next steps.
Already a pro? Just edit this README.md and make it your own. Want to make it easy? [Use the template at the bottom](#editing-this-readme)!
## Add your files
-[ ] [Create](https://docs.gitlab.com/ee/user/project/repository/web_editor.html#create-a-file) or [upload](https://docs.gitlab.com/ee/user/project/repository/web_editor.html#upload-a-file) files
-[ ] [Add files using the command line](https://docs.gitlab.com/ee/gitlab-basics/add-file.html#add-a-file-using-the-command-line) or push an existing Git repository with the following command:
-[ ] [Set up project integrations](https://agile.bu.edu/gitlab/ec327-public-projects/2024/group-3/-/settings/integrations)
## Collaborate with your team
-[ ] [Invite team members and collaborators](https://docs.gitlab.com/ee/user/project/members/)
-[ ] [Create a new merge request](https://docs.gitlab.com/ee/user/project/merge_requests/creating_merge_requests.html)
-[ ] [Automatically close issues from merge requests](https://docs.gitlab.com/ee/user/project/issues/managing_issues.html#closing-issues-automatically)
Use the built-in continuous integration in GitLab.
-[ ] [Get started with GitLab CI/CD](https://docs.gitlab.com/ee/ci/quick_start/index.html)
-[ ] [Analyze your code for known vulnerabilities with Static Application Security Testing (SAST)](https://docs.gitlab.com/ee/user/application_security/sast/)
-[ ] [Deploy to Kubernetes, Amazon EC2, or Amazon ECS using Auto Deploy](https://docs.gitlab.com/ee/topics/autodevops/requirements.html)
-[ ] [Use pull-based deployments for improved Kubernetes management](https://docs.gitlab.com/ee/user/clusters/agent/)
-[ ] [Set up protected environments](https://docs.gitlab.com/ee/ci/environments/protected_environments.html)
***
# Editing this README
When you're ready to make this README your own, just edit this file and use the handy template below (or feel free to structure it however you want - this is just a starting point!). Thanks to [makeareadme.com](https://www.makeareadme.com/) for this template.
## Suggestions for a good README
Every project is different, so consider which of these sections apply to yours. The sections used in the template are suggestions for most open source projects. Also keep in mind that while a README can be too long and detailed, too long is better than too short. If you think your README is too long, consider utilizing another form of documentation rather than cutting out information.
## Name
Choose a self-explaining name for your project.
## Description
Let people know what your project can do specifically. Provide context and add a link to any reference visitors might be unfamiliar with. A list of Features or a Background subsection can also be added here. If there are alternatives to your project, this is a good place to list differentiating factors.
## Badges
On some READMEs, you may see small images that convey metadata, such as whether or not all the tests are passing for the project. You can use Shields to add some to your README. Many services also have instructions for adding a badge.
## Visuals
Depending on what you are making, it can be a good idea to include screenshots or even a video (you'll frequently see GIFs rather than actual videos). Tools like ttygif can help, but check out Asciinema for a more sophisticated method.
## Installation
Within a particular ecosystem, there may be a common way of installing things, such as using Yarn, NuGet, or Homebrew. However, consider the possibility that whoever is reading your README is a novice and would like more guidance. Listing specific steps helps remove ambiguity and gets people to using your project as quickly as possible. If it only runs in a specific context like a particular programming language version or operating system or has dependencies that have to be installed manually, also add a Requirements subsection.
## Usage
Use examples liberally, and show the expected output if you can. It's helpful to have inline the smallest example of usage that you can demonstrate, while providing links to more sophisticated examples if they are too long to reasonably include in the README.
## Support
Tell people where they can go to for help. It can be any combination of an issue tracker, a chat room, an email address, etc.
## Roadmap
If you have ideas for releases in the future, it is a good idea to list them in the README.
## Contributing
State if you are open to contributions and what your requirements are for accepting them.
For people who want to make changes to your project, it's helpful to have some documentation on how to get started. Perhaps there is a script that they should run or some environment variables that they need to set. Make these steps explicit. These instructions could also be useful to your future self.
You can also document commands to lint the code or run tests. These steps help to ensure high code quality and reduce the likelihood that the changes inadvertently break something. Having instructions for running tests is especially helpful if it requires external setup, such as starting a Selenium server for testing in a browser.
## Authors and acknowledgment
Show your appreciation to those who have contributed to the project.
## License
For open source projects, say how it is licensed.
## Project status
If you have run out of energy or time for your project, put a note at the top of the README saying that development has slowed down or stopped completely. Someone may choose to fork your project or volunteer to step in as a maintainer or owner, allowing your project to keep going. You can also make an explicit request for maintainers.
# EC327 Final Project - Group 3 - JARMA
---
## Summary
### Project type
Unit Converter Android App
### TL;DR
An app that takes an input number, unit, and desired unit; then converts the input to the desired unit.
### Description
This project aims to be able to convert between units, whether it is time, energy, length, etc. The user will be able to easily be able to convert units through the app with its simple interface. After the user inputs the value, they will be able to go through three drop down menus, one selecting the units to be converted from, the second being the units converted to, and the third is the type of units being converted. Once satisfied, the user will be able to confirm and the app will convert those units accordingly. The user is also able to create their own custom units and convert them to either the units already included or another custom unit made with the same base type. The app also creates a logger folder within the files of the phone, and will be found on the files app, keeping track of every conversion that was done and created, and keeping track of previous custom units.
- Organized meeting times and determined project direction
- Wrote about half of the minimum requirements part of the project
- converted original Java file to C++ for integration
- Worked on Presentation slides
- wrote this entire ReadMe file
Brian:
- Wrote second half of basic requirements
- Did most of the work on presentation slides
- converted original java file to C++ for integration
Aziz:
- Organized meeting times and determined project direction
- came up with the idea for and wrote the part of the project that handled custom unit conversion
- Worked to modify files to make C++ integration work as intended
Ryan:
- Organized meeting times and determined project direction
- Wrote entire Front-end file (layout and dropdown menus)
- Wrote part of the basic requirements file
- Helped Aziz write his custom unit conversion
Matthew:
- Organized meeting times and determined project direction.
- Wrote script that created a log of past conversions and added it to the UI
- Worked to modify existing Java files to make C++ integration work as intended
---
## Accomplishments
### Minimum requirements
#### Completed
app can be used to convert between common units for each of the following metrics:
- angles
- area
- data transfer rate
- digital storage
- duration
- energy
- force
- length
- mass
- power
- pressure
- speed
- temperature
- volume
### Possible features
#### Completed
- logged all conversions in an easily viewable file
- Computed calculations natively in C++ to improve efficiency
- Added a feature that allows users to create custom units that they can use the same way that they use the app's base units (the custom unit appears in the dropdown menu)
---
## Execution
### Project source
We did not use any Non-Standard libraries
### Installation
Our project does not run on the lab machines due to them having an outdated version of Android studio. Here is how to install and run the project if you have a working version of Android Studio:
- From the command line use the command: "git clone -b draft https://agile.bu.edu/gitlab/ec327/projects/group3project.git".
- Open android studio
- Open Unit Converter Project in group3project
- Open File then Sync Project with gradle files. Alternatively you can press CTRL + SHIFT + O to do the same thing
- Open Running Devices on the right side of the screen (if there is no device displayed add "Medium Phone API 35")
- Press Run
### Usage
How to Convert between Units:
- Select the type of unit you want to convert from the topmost dropdown
- Select your input unit from the second dropdown menu
- Select your desired unit from the third dropdown menu
- Type your input into the designated fields
- Hit the convert button, the conversion will appear at the top of the screen
How to View the Log:
- Go into the files app on whatever device you are using
- open the file called "ConversionLog.txt"
How to input a custom unit:
- Hit the "Create Custom Unit" button at the bottom of the screen
- Select the metric that you want the unit to measure (length, Duration, Energy, ect.)
- Type a name for your new unit into the first field
- Type the conversion rate from your unit to the base unit for your chosen metric
- Hit confirm
- Your unit will now appear in the dropdown menu for your chosen metric. You can convert between units the same way you would with the units we put in the app by default
---
## Miscellaneous
### Supporting material
Our presentation slides are included in the 'Master' branch
