https://github.com/ankitrajput0096/spring-boot-aws-s3
Dockerized Spring Boot application integrated with AWS S3 to preform CRUD operation on files. Also, handles custom spring boot application using controllerAdvice.
https://github.com/ankitrajput0096/spring-boot-aws-s3
aws aws-s3 docker docker-compose postman spring-boot
Last synced: 3 months ago
JSON representation
Dockerized Spring Boot application integrated with AWS S3 to preform CRUD operation on files. Also, handles custom spring boot application using controllerAdvice.
- Host: GitHub
- URL: https://github.com/ankitrajput0096/spring-boot-aws-s3
- Owner: ankitrajput0096
- Created: 2020-12-13T15:21:38.000Z (over 5 years ago)
- Default Branch: main
- Last Pushed: 2020-12-25T09:16:21.000Z (over 5 years ago)
- Last Synced: 2025-02-26T03:45:40.702Z (over 1 year ago)
- Topics: aws, aws-s3, docker, docker-compose, postman, spring-boot
- Language: Java
- Homepage:
- Size: 13.9 MB
- Stars: 0
- Watchers: 2
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# Integration of Spring boot application with AWS S3
Dockerized Spring Boot application integrated with AWS S3 to preform CRUD operation on files.
Also, handles custom spring boot application using controllerAdvice.
## Getting Started
These instructions will get you a copy of the project up and running on your local machine for development purposes. See running for notes on how to run the project on a system.
### Prerequisites
1. Clone the project to your local environment:
```
git clone https://github.com/ankitrajput0096/Spring-Boot-AWS-S3
```
2. You need maven installed on your environment:
#### Mac (homebrew):
```
brew install maven
```
#### Ubuntu:
```
sudo apt-get install maven
```
3. You need Docker to be installed:
#### Windows:
https://download.docker.com/win/stable/Docker%20for%20Windows%20Installer.exe
#### Mac:
https://download.docker.com/mac/stable/Docker.dmg
#### Ubuntu:
https://docs.docker.com/install/linux/docker-ce/ubuntu/
### NOTE
Please create a S3 bucket first and then update the details of the bucket in application.properties of
the spring boot application. Properties you need to add are `region`, `accesskey` and `secretKey`.
### Installing
Once you have maven and docker installed on your environment, install the project dependencies via:
```
mvn install
```
Build docker Image:
```
docker-compose build
```
## Running
Start docker:
```
docker-compose up
```
Or Run the application from the `Application.java` main method directly,
Or from a command line:
```
mvn spring-boot:run
```
Your server should be now running on http://localhost:8080
## Get access to all exposed API's with Postman
1. Install Postman (https://www.getpostman.com)
2. Import Postman collection from the `Spring_boot_S3_application.postman_collection.json` file
3. Enjoy !!
## Built With
* [Spring Boot](https://spring.io/projects/spring-boot) - Spring Boot 2
* [Maven](https://maven.apache.org/) - Dependency Management
* [Docker](https://www.docker.com/) - For containerization of application
## Contributing
If you have any improvement suggestions please create a pull request and I'll review it.
## Authors
* **Ankit Rajput** - *Initial work* - [Github](https://github.com/ankitrajput0096)
## License
This project is licensed under the MIT License
## Acknowledgments
* Big thanks to Pivotal for Spring Boot framework, love it!