Yet another backup tool. Intended to backup all your resources (files, facebook pics, instagram posts, etc) and have a unique place where you can find them.
After some time not doing software I wanted to refresh my Java skills, so this is a project in which I intend to refresh them and additionally learn more about the following topics:
- Clean Architecture
- Spring Boot
- OAuth2
- Java 8
If you are interested on its roadmap, or just what it's going on here, please visit Backupr roadmap
For any suggestion, comment, request or advise, please open an issue in Github, I will surely reach you back :-)
These instructions will get you a copy of the project up and running on your local machine for development and testing purposes. See deployment for notes on how to deploy the project on a live system.
To build the software you need to following tools:
- Java 8
- Maven 3.6.x
- AWS s3
- Make
- Bash shell
As this is a simple Spring Boot project built with Maven, to install the software it is as easy as:
cd backupr-cli
mvn clean package
once you have it build you can run it using the sample commands in the Makefile in backupr-cli folder:
cd backupr-cli
make dev_upload_folder
or
cd backupr-cli
make dev_download_file
Please be sure to have data in your S3 bucket in order to be able to download something.
cd backupr-cli
mvn test
Nothing defined yet.
Nothing defined yet.
As it is a CLI at the moment, it is as simple as running in locally. Nonetheless you will need a S3 bucket to store and retrieve the files, which can be setup in the following files:
src/main/resources/application.yml
section:
aws -> credentials -> bucket-name
- Spring Boot - The main application framework
- Maven - Dependency Management
Rules are not defined yet, but contributions are always welcome, all Pull Requests are welcome :-)
- Miquel Millan - Initial work
This project is licensed under the GPL v3 License - see the LICENSE file for details
- Soon :-)