Code Monkey home page Code Monkey logo

backupr's Introduction

Backupr

Quality Gate Status

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 :-)

Getting Started

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.

Prerequisites

To build the software you need to following tools:

- Java 8
- Maven 3.6.x
- AWS s3
- Make
- Bash shell

Installing

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.

Running the tests

cd backupr-cli
mvn test

Break down into end to end tests

Nothing defined yet.

And coding style tests

Nothing defined yet.

Deployment

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

Built With

Contributing

Rules are not defined yet, but contributions are always welcome, all Pull Requests are welcome :-)

Authors

  • Miquel Millan - Initial work

License

This project is licensed under the GPL v3 License - see the LICENSE file for details

Acknowledgments

  • Soon :-)

backupr's People

Contributors

miquelmillan avatar dependabot[bot] avatar

Watchers

James Cloos avatar  avatar Fran Navarro Alcaraz avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.