Code Monkey home page Code Monkey logo

waes's Introduction

Waes Scalable Web Application

WAES assignment Project for the Java Developer .

Assignment

  • Provide 2 http endpoints that accepts JSON base64 encoded binary data on both endpoints
    • /v1/diff//left and /v1/diff//right
  • The provided data needs to be diff-ed and the results shall be available on a third end point.
    • /v1/diff/
  • The results shall provide the following info in JSON format
    • If equal return that
    • If not of equal size just return that
    • If of same size provide insight in where the diffs are, actual diffs are not needed. So mainly offsets + length in the data

Tech

Application uses a number of open source projects to work properly:

  • Java 8- Primary Language
  • Spring boot - An open source Java-based framework used to create a micro Service.
  • Maven - Dependency Management
  • Mongodb- Document database with the scalability and flexibility that you want with the querying and indexing that you need
  • JUnit 1.4, Mockito, Spring boot Test - For Unit and Integration Tests
  • JaCoCo - Maven plugin to generate a code coverage report for a Java project.

Cloning Repository

$ git clone https://github.com/mehmetfatihustdag/waes.git

Installation

After cloning or downloading the repository. Follow to steps to test and run the project.

You will need to be go to folder where pom.xml located.

   $ cd waes

Steps to Test :

$ mvn test

Steps to Run :

$ mvn spring-boot:run

Project will run under the http://localhost:8080 Note : 8080 is configurable port it can be changed via application.yml file

Swagger UI :

Application Endpoints documented via Swagger . You can find the swagger ui below link, and test endpoints via browser as well http://localhost:8080/swagger-ui.html

Test Reports :

After running the test, you can find the test coverage reports which JaCoCo plugin provided by opening the file which is under target/site/jacoco/index.html

Suggestion For Improvements :

  • Write MORE Tests
  • For High traffic request environment diff process could work slow, or could timeout. Diff process can be asynchronous. Queue technologies (ActiveMQ, RabbitMQ, Kafka,...) could be used in order to provide asynchronous consumer process.
  • I used Embedded MongoDB for demonstration purpose. Real ones can be used
  • Development, test , and production profiles can be used.

Author

Fatih Ustdag [email protected]

waes's People

Watchers

James Cloos avatar  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.