Skip to content

A Spring Boot Application built with Java. The application displays use of MVC architecture in conjunction with Robert C Martin's Clean Architecture Guide.

License

Notifications You must be signed in to change notification settings

otsembo/DataParser

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

36 Commits
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

DATA PARSER

GitHub issues GitHub forks GitHub stars GitHub license

Description

Data Parser is a Java application built with Spring Boot 2.6.+ and Spring Framework 5.+.

The application is used as a demonstration for working with CSV file in Java.

Live Link

DATA PARSER IN ACTION

App Architecture

This application was built with the following in mind:

  • MVC - The traditional MVC architecture that makes use of the Controller as the key component in the entire application.
  • Clean Architecture - A convention adopted by Robert C Martin. Uncle bob speaks of separation of concerns that eases the rate of development and allows for complete modularity of components during development, testing and production.

Getting Started

In order for you to use the content on this repo ensure you have the following:

  • A computer that runs on either of the following; (Windows 7+, Linux, Mac OS)
  • Java JDK 1.8+ Download
  • Some bit of patience for your own sanity.

Dependencies

This application was built with the following dependencies:

  • Spring Boot - Server-side web framework
  • Thymeleaf - Templating engine for Spring
  • Gson - JSON Serializer library
  • Maven - Build tool for managing application dependencies
  • JUnit - Unit testing
  • Mockito - Mocking for easy Unit testing
  • Hamcrest - Complementary Unit testing library

Installation

To use this repo on your machine requires some simple steps

Alternative One

  • Open a terminal / command line interface on your computer

  • Clone the repo by using the following:

      git clone https://github.com/otsembo/DataParser.git
    
  • Be patient as it creates a copy on your local machine for you.

  • Change directory to the repo folder:

      cd DataParser
    
  • (Optional) Open it in Visual Studio Code

      code .
    
  • (Alternate Option) Open it in any editor of your choice.

  • Hurray! You are one step closer to being as intelligent as Einstein.

Alternative Two

  • On the top right corner of this page there is a button labelled Fork.

  • Click on that button to fork the repo to your own account.

  • Take on the process in Alternative One above.

  • Remember to replace your username when cloning.

      git clone https://github.com/your-username-here/DataParser.git
    

Running the application

Running the application is very straight forward. You can use the following steps to run the app.

  • Install required dependencies from maven

    mvn install
    
  • Run the application on the browser

    mvn spring-boot:run
    
  • Open the application on your browser's localhost on port 8080

    https://127.0.0.1:8080
    

Screenshots

Take a snippet at what the application looks like

HOME SCREEN DATA SCREEN
ADD DATA UPDATE DATA

Known Bugs

At this time there are no known bugs. If there is any occurring while you are experiencing the website kindly notify me on My email

Authors

This project was contributed to by:

License

The project is licensed under Apache 2.0.

About

A Spring Boot Application built with Java. The application displays use of MVC architecture in conjunction with Robert C Martin's Clean Architecture Guide.

Topics

Resources

License

Stars

Watchers

Forks

Packages

No packages published