Skip to content

Commit

Permalink
Added a screenshot of the working project in the README.md. Improved …
Browse files Browse the repository at this point in the history
…the project description and key features, Removed an unnecessary import in the MainPanel
  • Loading branch information
RutujChheda committed Jun 15, 2024
1 parent 8c6ebab commit a8f74e4
Show file tree
Hide file tree
Showing 16 changed files with 53 additions and 48 deletions.

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

Empty file.
Empty file.

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

Empty file.
Empty file.
10 changes: 1 addition & 9 deletions .idea/sonarlint/issuestore/index.pb

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

Empty file.
Empty file.
Empty file.
Empty file.
10 changes: 1 addition & 9 deletions .idea/sonarlint/securityhotspotstore/index.pb

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

41 changes: 32 additions & 9 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,20 @@
# Photo Filters App

This is a Java application that allows users to apply different filters to their photos. The application uses Dagger for dependency injection and Gradle for build automation.
This is a sample Java application that allows users to apply different filters to their photos.
The application allows users to load an image from their local file system, apply filters to the image, and save the filtered image back to their local file system.
Currently, the application supports the following filters:
- Grayscale
- Sepia
- Invert

![Application Preview](src/main/resources/App_Working_Sample.jpg)

#### Key Features
- **User-Friendly Interface:** Built with Java Swing for a familiar and intuitive experience.
- **Image Manipulation:** Leverages Java AWT for efficient image processing.
- **Clean Architecture:** Employs the Model-View-Controller (MVC) pattern for well-organized code.
- **Dependency Injection:** Uses Dagger for streamlined dependency management.
- **Build Automation:** Powered by Gradle for easy project setup and management.

## Getting Started

Expand All @@ -18,31 +32,40 @@ These instructions will get you a copy of the project up and running on your loc
git clone https://github.com/RutujChheda/photofiltersapp.git
```

1. Navigate to the project directory
2. Navigate to the project directory
```bash
cd photofiltersapp
```

2. Build the project
3. Build the project
```bash
gradle build
```
3. Usage
4. Usage
```bash
gradle run
```

## Architecture Diagrams

### PhotoConverterManualTester Main Calls

### PhotoFiltersApp Structure
![PhotoConverterManualTester Structure](src/main/resources/PhotoConverterManualTester_structure.svg)
[Project Structure](src/main/resources/MainPanel_structure.puml)

### PhotoFiltersApp Main Calls
![PhotoConverterManualTester Main Calls](src/main/resources/PhotoConverterManualTester_0_main_calls.svg)
[Project Calls Sequence](src/main/resources/MainPanel_0_MainPanel_calls.puml)
### PhotoConverterManualTester Structure

![PhotoConverterManualTester Structure](src/main/resources/PhotoConverterManualTester_structure.svg)
[Project Structure](src/main/resources/MainPanel_structure.puml)


### Contributing
Pull requests are welcome. For major changes, please open an issue first to discuss what you would like to change.

Please make sure to update tests as appropriate.
Please make sure to update tests as appropriate.

### How to Contribute:
1. Fork the repository.
2. Create a new branch for your feature or bug fix.
3. Make your changes and commit them with clear descriptions.
4. Push your changes to your fork.
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
package com.rutuj.photofiltersapp.view;

import com.google.common.collect.ImmutableList;

import com.rutuj.photofiltersapp.activity.ConvertPhotoActivity;
import com.rutuj.photofiltersapp.dependency.DaggerServiceComponent;
import com.rutuj.photofiltersapp.dependency.ServiceComponent;
Expand Down
Binary file added src/main/resources/App_Working_Sample.jpg
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.

0 comments on commit a8f74e4

Please sign in to comment.