Giter Club home page Giter Club logo

mock-company-webapp's Introduction

Mock Company E-Commerce Application

This is the e-commerce application for Mock Company. It's built using the following languages/frameworks

Language/Framework Usage Source Location
Java 8 API Services Language src/main/java
Gradle 6 Automation framework used for orchestrating the building/testing/packaging of the app build.gradle
Spring Framework for API development and dependency injection among other things src/main/java
JPA Java Persistence API - Java framework for data access ProductItem / ProductItemRepository
Groovy 2.4 Language for Gradle build file and writing unit tests src/test/groovy
Spock Framework for writing unit tests in Groovy src/test/groovy
Typescript Language for generating type safe javascript client-app/src
[React][react] Framework for building dynamic User Interfaces client-app/src
Material UI React library for building User Interfaces that meet the Material Design Spec client-app/src

Development Environment

To develop against this codebase, the following development tools should be installed on your workstation first:

IDE Setup

You can use your IDE of choice to develop in this app but it should have Java/Gradle support at a minimum. The best recommendation for IDE is IntelliJ Community Edition as it's free and works very well with Java/Gradle/Spring/Groovy/Spock.

Getting Started

All build/test commands are to be run through a terminal using the Gradle Wrapper file. This means, instead of each developer having to download and install the exact version of Gradle for the project, there are shell scripts: gradlew for posix (Mac/Linux) and gradlew.bat for Windows. These shell scripts should be used to execute any 'task', such as a build, assemble, or test.

For example, on Windows, to run all unit tests you would run: gradlew test and on Mac: ./gradlew test from the root of the repository where the gradlew files are located. On Windows, the .bat isn't needed because it automatically looks in the current working directory. Where on Mac/Linux, the developer has to use ./ at the beginning to indicate the script to run in the current working directory, indicated by the .

Running the Application

To build and start the application, run the Gradle bootRun task

./gradlew bootRun  # on Mac/Linux
gradlew bootRun    # on Windows

This will build the UI, build the Java API, and start the application at the following web address: http://localhost:8080

Common Gradle Tasks

  • test - run all unit tests
  • assemble - build and package the application
  • build - runs test and assemble
  • clean - removes generated files/folders
  • bootRun - compiles and runs the application

mock-company-webapp's People

Contributors

mschenke avatar partha23-github 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.