https://github.com/amanastel/visualizationdashboard
This project is a Java application that includes a Spring Boot service for managing data entities, a batch job for importing data from CSV to a database, and a controller for searching data entities based on various criteria.
https://github.com/amanastel/visualizationdashboard
java maven mysql spring-batch spring-boot
Last synced: 7 months ago
JSON representation
This project is a Java application that includes a Spring Boot service for managing data entities, a batch job for importing data from CSV to a database, and a controller for searching data entities based on various criteria.
- Host: GitHub
- URL: https://github.com/amanastel/visualizationdashboard
- Owner: Amanastel
- Created: 2023-09-26T21:59:49.000Z (about 2 years ago)
- Default Branch: main
- Last Pushed: 2023-10-08T22:38:29.000Z (about 2 years ago)
- Last Synced: 2025-01-13T02:41:08.464Z (9 months ago)
- Topics: java, maven, mysql, spring-batch, spring-boot
- Language: Java
- Homepage:
- Size: 211 KB
- Stars: 2
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# Visualization Dashboard
This project is a Java application that includes a Spring Boot service for managing data entities, a batch job for importing data from CSV to a database, and a controller for searching data entities based on various criteria.
## Table of Contents
- [Introduction](#introduction)
- [Prerequisites](#prerequisites)
- [Getting Started](#getting-started)
- [Installation](#installation)
- [Usage](#usage)
- [Project Structure](#project-structure)
- [Technologies Used](#technologies-used)
- [Contributing](#contributing)
- [License](#license)
- [Contact](#contact)
## Introduction
This Java project aims to provide functionality for managing and searching data entities. It includes the following components:
- **DataEntity**: A model class representing data entities with various attributes.
- **DataService**: A service interface and its implementation (`DataServiceImple`) for persisting and searching data entities.
- **JobController**: A controller for launching a batch job to import data from CSV to the database.
- **InvestigationController**: A new controller for searching data entities based on start year, end year, city, and topic.
## Prerequisites
Before you can run this project, ensure you have the following prerequisites:
- Java JDK 8 or higher
- MySQL database
- Spring Boot
## Getting Started
To get started with this project, follow the steps below:
### Installation
## Usage
To use this Java project, follow the steps below:
1. **Installation**:
- Clone the repository:
```bash
git clone https://github.com/Amanastel/VisualizationDashboard.git
cd VisualizationDashboard
```
- Build the project:
```bash
mvn clean install
```
2. **Running the Application**:
- Launch the Spring Boot application by executing the following command:
```bash
java -jar .jar
```
3. **Using the Application**:
- After starting the application, you can interact with it based on your requirements.
- For data entity management, you can utilize the `DataService` and related components.
- To import data from CSV to the database, you can use the `JobController`.
- For searching data entities based on criteria, access the `InvestigationController` and provide the necessary parameters.
Feel free to explore and utilize the various features of this application as per your needs.
Please replace `` with the actual name of your project's JAR file. This "Usage" section provides users with instructions on how to install, run, and utilize your project.
## Project Structure
The project is organized as follows:
- `com.blackcoffer.model`: Contains the `DataEntity` class representing data entities.
- `com.blackcoffer.Service`: Includes the `DataService` interface and its implementation (`DataServiceImple`) for data management.
- `com.blackcoffer.controller`: Contains controllers for batch job (`JobController`) and data searching (`InvestigationController`).
- `application.properties`: Configuration file for database connection and Spring Batch.
- `pom.xml`: Maven configuration file specifying project dependencies.
This structure provides a clear organization of your project's components, making it easier for developers to navigate and understand your codebase.
## Technologies Used
The following technologies, libraries, and frameworks are used in this project:
- **Java**: The primary programming language for developing the application.
- **Spring Boot**: A Java-based framework used for building the service and controllers.
- **MySQL**: The database management system used for storing data.
- **Spring Batch**: A framework for processing large volumes of data, utilized for the batch job.
These technologies work together to create a robust Java application for managing and searching data entities.
## Contributing
We welcome contributions to improve this project. To contribute, please follow these steps:
1. Fork this repository.
2. Create a new branch for your feature or bug fix: `git checkout -b feature-name`
3. Make your changes and commit them: `git commit -m 'Add feature'`
4. Push your changes to your fork: `git push origin feature-name`
5. Create a pull request from your fork to this repository.
Please provide a clear description of your changes, and make sure your code follows the project's coding standards.
## License
This project is licensed under the [License Name](LICENSE).
## Contact
If you have any questions, suggestions, or need assistance with this project, please feel free to reach out to us. You can contact us via the following methods:
- Email: [amankumar.ak0012@gmail.com](mailto:amankumar.ak0012@gmail.com)
- LinkedIn: [Aman Kumar on LinkedIn](https://www.linkedin.com/in/amanastel/)
- GitHub: [Aman Kumar on GitHub](https://github.com/amanastel)
We welcome feedback and contributions from the community and are happy to assist you with any inquiries related to this project.