master - 
A java-based automated CLI inventory manager for cafe shops.
Check out our website here
These instructions will get you a copy of the project up and running on your local machine for development and testing purposes. See deployment for notes on how to deploy the project on a live system.
- Java JDK (8 or higher)
- Optional if using wrapper Gradle (4.6 or higher)
- Optional IntelliJ IDEA
- Optional CheckStyle Plugin for IntelliJ IDEA
- Optional FindBugs Plugin for IntelliJ IDEA
- Optional PMD Plugin for IntelliJ IDEA Plugin
Note Depending on your system, it might be necessary to use ./gradlew or ./gradlew.bat instead of gradle.
After cloning and forking the repository, run the following command in the command line (or terminal) within the local directory:
gradle build
To execute the program:
gradle run
To clean the repository of the current build:
gradle clean
To build the IntelliJ idea files, run the following command:
gradle idea
To clean the IntelliJ files:
gradle cleanIdea
To see all available tasks:
gradle tasks
We use JUnit to automate our testing. To run all unit tests, run in the command line (or terminal):
gradle test
We use CheckStyle, PMD, and FindBugs to analyze and our codebase and generate reports. To generate reports, run the following command:
gradle check
Note generated reports can be found under build/reports after running the above command.
Currently there is no way of deploying this system, will add this as TODO.
- Gradle - Build automation tool
- Travis CI - Continuous integration
- CheckStyle - Enforces Proper Coding Style Conventions
- FindBugs - Static Analysis Tool
- JUnit - Test automation tool
- PMD - Static Analysis Tool
Please read CONTRIBUTING for details on our code of conduct, and the process for submitting pull requests.
- Brady Pascoe - Team Manager - bpas247
- Justin Cheriyan - Software Developer - justincheriyan
- JD Mauthe - Software Developer - jdmauthe
We use SemVer for versioning.
This project is licensed under the MIT License - see the LICENSE.md file for details