SkyNotes

Lite cloud file storage
View Images · Report Bug · Request Feature

Table of Contents

1. About The Project
   • Built With
2. Getting Started
   • Prerequisites
   • Installation
3. Contributing
4. License
5. Contact
6. Images

About The Project

SkyNotes is a simple cloud file storage. It is a project that I have been working on for a while. It is a simple cloud file storage that allows you to upload files and share them with others.

Features:

• Upload files
• Share files and get share analytics
• Download files
• Delete files
• Create folders
• Thumbnail generation
• Media preview (images, videos, audio)

(back to top)

Built With

SkyNotes is built with the following technologies:

• 
• 
• 
• 

(back to top)

Getting Started

This is an example of how you may set up skynotes locally. There are a lot of ways, but I will show you the easiest one with use of Docker. To get a local copy up and running follow these simple steps.

Prerequisites

• docker and docker-compose (or any other containerization tool like podman)
• nodejs
• pnpm (or any other package manager)
• python3
• pip3
• virtualenv (or any other virtual environment)
• git
• make (optional)

Installation with Docker

Development

1. Clone the repo

   git clone https://github.com/style77/skynotes.git

2. Go to the project directory

   cd skynotes

3. Build and run the frontend

    pnpm install && pnpm run dev

4. Build and run the backend with Makefile

     make run-api

   or without Makefile

     docker-compose up -d --build

5. Open your browser and go to http://localhost:3000

(back to top)

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.

If you have a suggestion that would make this better, please fork the repo and create a pull request. You can also simply open an issue with the tag "enhancement". Don't forget to give the project a star! Thanks again!

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

(back to top)

License

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

(back to top)

Contact

Joachim Hodana - [email protected] Dominik Krakowiak

Project Link: https://github.com/style77/skynotes

(back to top)

Images

Index page

on RMB click you can see the context menu, for easier file/folder management

File upload

File preview

Music player

Sharing

Share modal

Share analytics (hover over the ip to see it, unfortunately lightshot removes cursor from screenshot, so mine is not there)