Handy Pantry

(Made by team Rocinante)

• Handy Pantry
  • (Made by team Rocinante)
  • About Handy Pantry
  • Development
    • Common commands
  • Deployment
  • Resources
  • Contributors

About Handy Pantry

Handy Pantry is a home pantry inventory management system, enabling the user to have an accurate idea of the current state of their pantry.

Development

Instructions on setting up the development environment and working with the code are in the development guide.

Common commands

From the server directory:

• ./gradlew run to start the server
• ./gradlew test to test the server
• ./gradlew checkstyleMain to run Checkstyle on the server Java code in the src/main folder
• ./gradlew checkstyleTest to run Checkstyle on the server Java code in the src/test folder
• ./gradlew check will run both the tests and Checkstyle in one command

From the client directory:

• ng serve to run the client
• ng test to test the client
  • Or ng test --no-watch --code-coverage to run the client tests once and also compute the code coverage.
• ng e2e and ng e2e --watch to run end-to-end tests

From the database directory:

• ./mongoseed.sh (or .\mongoseed.bat on Windows) to seed the database

Deployment

Instructions on how to create a DigitalOcean Droplet and setup your project are in the deployment guide.

Resources

Additional resources on tooling and techniques are in the resources list.

Contributors

The contributors to this project can be seen here.