https://github.com/rabby835/kloudy
🗃️ File storage
https://github.com/rabby835/kloudy
compose docker-compose docker-image dockerfile java kotlin maven rest-api restful-api spring spring-boot spring-security storage-service typescript
Last synced: 4 months ago
JSON representation
🗃️ File storage
- Host: GitHub
- URL: https://github.com/rabby835/kloudy
- Owner: Rabby835
- License: apache-2.0
- Created: 2025-04-22T07:15:40.000Z (6 months ago)
- Default Branch: main
- Last Pushed: 2025-06-21T05:18:28.000Z (4 months ago)
- Last Synced: 2025-06-21T06:02:22.023Z (4 months ago)
- Topics: compose, docker-compose, docker-image, dockerfile, java, kotlin, maven, rest-api, restful-api, spring, spring-boot, spring-security, storage-service, typescript
- Language: Java
- Size: 54.7 KB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- License: LICENSE
Awesome Lists containing this project
README
# Kloudy 🗃️ - Your Reliable File Storage Solution
Welcome to the **Kloudy** repository! This project provides a robust file storage solution built using modern technologies. Whether you need to store files for personal use or for a larger application, Kloudy offers a reliable and efficient way to manage your files.
## Table of Contents
- [Features](#features)
- [Technologies Used](#technologies-used)
- [Installation](#installation)
- [Usage](#usage)
- [API Documentation](#api-documentation)
- [Contributing](#contributing)
- [License](#license)
- [Contact](#contact)
## Features
- **Secure Storage**: Your files are safe with built-in security features.
- **RESTful API**: Easily interact with the storage service using our API.
- **Docker Support**: Quick deployment using Docker and Docker Compose.
- **Java 17**: Built with the latest version of Java for improved performance.
- **Spring Boot**: Leverage the power of Spring Boot for rapid development.
- **Maven**: Manage dependencies and build processes efficiently.
## Technologies Used
Kloudy is built using a combination of the following technologies:
- **Java 17**: The latest features and performance improvements.
- **Spring Boot**: A powerful framework for building RESTful applications.
- **Maven**: For project management and build automation.
- **Docker**: Containerization for easy deployment.
- **Spring Security**: Protect your application with authentication and authorization.
## Installation
To get started with Kloudy, follow these steps:
1. **Clone the repository**:
```bash
git clone https://github.com/Rabby835/kloudy.git
cd kloudy
```
2. **Build the project**:
Use Maven to build the project.
```bash
mvn clean install
```
3. **Run with Docker**:
You can run Kloudy using Docker. Ensure you have Docker and Docker Compose installed. Then, execute the following command:
```bash
docker-compose up
```
4. **Download the latest release**:
Visit the [Releases section](https://github.com/Rabby835/kloudy/releases) to download the latest version. After downloading, execute the file to start the service.
## Usage
Once Kloudy is up and running, you can use the RESTful API to interact with your file storage. Here are some basic operations:
### Upload a File
To upload a file, send a POST request to the `/upload` endpoint with the file included in the request body.
### Download a File
To download a file, send a GET request to the `/download/{filename}` endpoint.
### List Files
To get a list of all stored files, send a GET request to the `/files` endpoint.
## API Documentation
For detailed API documentation, please refer to the following endpoints:
- **POST /upload**: Upload a file.
- **GET /download/{filename}**: Download a specific file.
- **GET /files**: List all files stored.
You can test these endpoints using tools like Postman or curl.
## Contributing
We welcome contributions to Kloudy! If you want to help improve the project, please follow these steps:
1. Fork the repository.
2. Create a new branch for your feature or bug fix.
3. Make your changes and commit them.
4. Push to your branch.
5. Open a pull request.
Please ensure your code follows the project's coding standards and includes tests where applicable.
## License
This project is licensed under the MIT License. See the [LICENSE](LICENSE) file for details.
## Contact
For questions or suggestions, feel free to reach out:
- **GitHub**: [Rabby835](https://github.com/Rabby835)
- **Email**: rabby@example.com
Thank you for checking out Kloudy! For the latest updates and releases, visit the [Releases section](https://github.com/Rabby835/kloudy/releases).
Let’s make file storage simple and efficient together!