https://github.com/farbautie/ygg

self-hosted personal cloud project inspired by the Norse tree of life.
https://github.com/farbautie/ygg

docker golang react self-hosted

Last synced: 2 days ago
JSON representation

self-hosted personal cloud project inspired by the Norse tree of life.

• Host: GitHub
• URL: https://github.com/farbautie/ygg
• Owner: farbautie
• License: agpl-3.0
• Created: 2024-11-20T03:47:17.000Z (2 months ago)
• Default Branch: main
• Last Pushed: 2024-11-20T04:27:17.000Z (2 months ago)
• Last Synced: 2024-11-20T05:23:41.346Z (2 months ago)
• Topics: docker, golang, react, self-hosted
• Homepage:
• Size: 15.6 KB
• Stars: 0
• Watchers: 1
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • Contributing: CONTRIBUTING.md
  • License: LICENSE
  • Code of conduct: CODE_OF_CONDUCT.md
  • Security: SECURITY.md

Awesome Lists containing this project

README

        
# Ygg - Your Personal Home Cloud

## What is it?

Ygg is a **self-hosted** personal cloud project inspired by the Norse tree of life.

Designed to centralize and protect your files, Ygg turns your home into a private

and secure space for storing data without relying on external services.

## Initial Features

- 🌐 Custom Storage:

  Save, organize, and access your files from any device within your local network.

- 📂 File Browser:

  Browse and manage your files in a familiar and intuitive interface.

- 🔐 Local Security:

  Your data stays at home, away from third-party servers.

- ⚡ Easy Installation

  Ready to be set up on a Raspberry Pi or any Linux system.

## System Requirements

- 💻 Hardware:

  - Raspberry Pi 4 (+ 4GB RAM)

  - external SSD or HDD for Storage

- 🖥️ Software:

  - Raspberry Pi OS (32-bit or 64-bit) or Ubuntu

  - Backend: Go (1.23.x)

  - Frontend: React (18.3.x)

  - Optional: Docker for containerized deployment.

## Installation

- 📦 Clone the repository:

  ```bash

  git clone https://github.com/farbautie/ygg.git

  ```

- Coming soon...

## Roadmap

- [ ] Basic local storage API in Go

- [ ] Implement a local file upload/download system

- [ ] Develop a basic frontend for file management

- [ ] Implement a basic authentication System

- [ ] Implement a basic user management System

- [ ] Implement a basic file sharing System

- [ ] Enable basic folder and file organization

## Contributing

Contributions are welcome!

If you find a bug or have a feature request, please

open an issue on the GitHub repository.

If you'd like to contribute code, please fork the repository and submit a pull request.

## License

This project is licensed under the GNU Affero General Public License v3.0 (AGPL-3.0).

See the [LICENSE](LICENSE) file for more information.