Skip to content

README.md

Latest commit

 

History

History
119 lines (92 loc) · 3.36 KB

README.md

File metadata and controls

119 lines (92 loc) · 3.36 KB
Raw

Logo

SFTP Client

Transfer files securely to and from a remote computer.
Explore the docs »

View Demo · Report Bug · Request Feature

Table of Contents

About the Project

This SFTP Client was originally created by a team of students in order to learn agile practices while developing a product. The result is a simple, menu-based command line program that walks the user through a secure transfer of files to and from a remote computer.

Built With

Getting Started

Folow these instructions to get a local copy of this application up and running.

Prerequisites

Installation

  1. Clone the repo
git clone https://github.com/rooneyshuman/SFTP-App.git
  1. Build the project
mvn package
  1. Run the project in an IDE
Right-click Main.java -> Run 'Main.main()'

Usage

The application will prompt the user to establish an SFTP connection or exit the program. To establish a connection, the program will prompt the user for the following information.

Enter your username:
exampleUser

Enter your password:
strongPassword

Enter your hostname:
linux.cs.pdx.edu

Once a connection is established, the user is provided a menu to securely manage files.

Testing

All unit tests are located in the test folder and require the login variables to be updated to credentials for a valid SFTP connection.

Contributing

Contributions are what make the open source community such an amazing place to learn, inspire, and create. Any contributions you make are greatly appreciated.

  1. Fork the project
  2. Create your feature branch (git checkout -b feature/AmazingFeature)
  3. Commit your changes (git commit -m 'Add some AmazingFeature)
  4. Push to the branch (git push origin feature/AmazingFeature)
  5. Open a pull request

Contributors

License

Distributed under the MIT License. See LICENSE.md for more information.

Acknowledgements