→ File Transfer System ←

📔 Table of Contents

• 🌟 About the Project
  • 📓 Description
  • 👀 Features
  • 👾 Tech Stack
  • 🔑 Environment Variables
• 🧰 Getting Started
  • ⚠️ Prerequisites
  • ⚙️ Setup
  • 🚀 Run

About the Project

Description

An FTP Server and Client application built with Java. Upon initialization, the server will automatically generate a designated folder for file storage, should this folder not already be present. Subsequently, it will proceed to accept client connections, ready to receive and store files sent by the clients.

Features

• ✓ Support for concurrent client connections
• ✓ File upload, download, and deletion capabilities
• ✓ Directory navigation and file listing
• ✓ Graphical User Interface for the client application
• ✓ Password Authentication
• ✓ Docker support

Tech Stack

• → Java
• → Maven
• → Docker
• → Swing (for Client GUI)

Environment Variables

To run this project, you will need to add the following environment variables to your .env file

📁 DEFAULT_PORT

🌍 DEFAULT_SERVER_NAME

💾 STORAGE_DIRECTORY_NAME

🔒SERVER_PASSWORD

Getting Started

Prerequisites

• ★ Java JDK 17 or newer
• ★ Maven
• ★ Docker (optional for containerization)

Setup

Clone the project

  git clone https://github.com/nidorbRotkiv/FileTransferSystem.git

Run

1️⃣ Package the project

mvn package

2️⃣ Run the server

mvn exec:java@run-server

3️⃣ Run a client in a new terminal window (or tab)

mvn exec:java@run-client-gui