Git Product home page Git Product logo

swen261's Introduction

E-Store: Mechanical Keyboard Store

Modify this document to expand any and all sections that are applicable for a better understanding from your users/testers/collaborators (remove this comment and other instructions areas for your FINAL release)

An online E-store system built in Java 11=>, Spring Boot, Typescript & Angular.

Team

  • Siddhartha Juluru
  • Ashlyn King
  • Cathy Liu
  • Issac Kim

Prerequisites

  • Java 8=>11 (Make sure to have correct JAVA_HOME setup in your environment)
  • Maven
  • add any other tech stack requirements

How to run it

  1. Clone the repository and go to the root directory.
  2. Execute mvn compile exec:java
  3. Open in your browser http://localhost:8080/
  4. add any other steps required or examples of how to use/run

Known bugs and disclaimers

(It may be the case that your implementation is not perfect.)

Document any known bug or nuisance. If any shortcomings, make clear what these are and where they are located.

How to test it

The Maven build script provides hooks for run unit tests and generate code coverage reports in HTML.

To run tests on all tiers together do this:

  1. Execute mvn clean test jacoco:report
  2. Open in your browser the file at PROJECT_API_HOME/target/site/jacoco/index.html

To run tests on a single tier do this:

  1. Execute mvn clean test-compile surefire:test@tier jacoco:report@tier where tier is one of controller, model, persistence
  2. Open in your browser the file at PROJECT_API_HOME/target/site/jacoco/{controller, model, persistence}/index.html

To run tests on all the tiers in isolation do this:

  1. Execute mvn exec:exec@tests-and-coverage
  2. To view the Controller tier tests open in your browser the file at PROJECT_API_HOME/target/site/jacoco/model/index.html
  3. To view the Model tier tests open in your browser the file at PROJECT_API_HOME/target/site/jacoco/model/index.html
  4. To view the Persistence tier tests open in your browser the file at PROJECT_API_HOME/target/site/jacoco/model/index.html

*(Consider using mvn clean verify to attest you have reached the target threshold for coverage)

How to generate the Design documentation PDF

  1. Access the PROJECT_DOCS_HOME/ directory
  2. Execute mvn exec:exec@docs
  3. The generated PDF will be in PROJECT_DOCS_HOME/ directory

How to setup/run/test program

  1. Tester, first obtain the Acceptance Test plan
  2. IP address of target machine running the app
  3. Execute ________
  4. ...
  5. ...

License

MIT License

See LICENSE for details.

swen261's People

Contributors

archturtle avatar idk4565 avatar cl6606 avatar ashlynking5901 avatar github-classroom[bot] avatar

Watchers

 avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.