diff --git a/.github/FUNDING.yml b/.github/FUNDING.yml deleted file mode 100644 index fb15ae3..0000000 --- a/.github/FUNDING.yml +++ /dev/null @@ -1,12 +0,0 @@ -# These are supported funding model platforms - -github: # Replace with up to 4 GitHub Sponsors-enabled usernames e.g., [user1, user2] -patreon: subnub -open_collective: # Replace with a single Open Collective username -ko_fi: # Replace with a single Ko-fi username -tidelift: # Replace with a single Tidelift platform-name/package-name e.g., npm/babel -community_bridge: # Replace with a single Community Bridge project-name e.g., cloud-foundry -liberapay: # Replace with a single Liberapay username -issuehunt: # Replace with a single IssueHunt username -otechie: # Replace with a single Otechie username -custom: # Replace with up to 4 custom sponsorship URLs e.g., ['link1', 'link2'] diff --git a/github_images/context.png b/github_images/context.png new file mode 100644 index 0000000..685ae19 Binary files /dev/null and b/github_images/context.png differ diff --git a/github_images/multiselect.png b/github_images/multiselect.png new file mode 100644 index 0000000..e3aa013 Binary files /dev/null and b/github_images/multiselect.png differ diff --git a/readme.md b/readme.md index 1f10201..6242192 100755 --- a/readme.md +++ b/readme.md @@ -13,7 +13,7 @@ MyDrive is an Open Source cloud file storage server (Similar To Google Drive). H - [Features](#features) - [Tech stack](#tech-stack) - [Installation (non docker)](#installation) -- [Docker](#docker) +- [Docker installation](#docker) - [Common installation issues](#common-installation-issues) - [Screenshots](#screenshots) - [Video](#video) @@ -52,6 +52,7 @@ MyDrive is an Open Source cloud file storage server (Similar To Google Drive). H - Express - MongoDB - Vite +- Jest @@ -82,7 +83,8 @@ npm install > [backend/config](backend/config) -> Backend Enviroment Variables > [src/config](src/config) -> Frontend Enviroment Variables -> Simply remove the .example from the end of the filename, and fill in the values. +> Simply remove the .example from the end of the filename, and fill in the values. +> Note: In most cases you will only have to change FE enviroment variables for development purposes.
@@ -144,7 +146,8 @@ Setup: > [backend/config](backend/config) -> Backend Enviroment Variables > [src/config](src/config) -> Frontend Enviroment Variables -> Simply remove the .example from the end of the filename, and fill in the values. +> Simply remove the .example from the end of the filename, and fill in the values. +> Note: In most cases you will only have to change FE enviroment variables for development purposes.
@@ -185,6 +188,12 @@ Search For Files/Folders Move File/Folders ![Move](github_images/move.png) +Multi-select +![Multi-select](github_images/multiselect.png) + +Custom context menu +![Context menu](github_images/context.png) + Trash ![Trash](github_images/trash.png) @@ -202,9 +211,13 @@ I created a short YouTube video, showing off myDrives design and features: (Comi Note: Creating, deleting and other features are disabled in the demo. Also the service worker is not enabled in the demo, images thumbnails are not cached because of this. +Also this is just a 512mb RAM droplet go easy on her. + -## 👾 Bug reports and Feature Requests +## 👾 Bug reports and feature requests + +Please only open issues for actual bugs, feature requests or discussions should happen in Discussions or via my email. Contact Email: kyle.hoell@gmail.com @@ -235,13 +248,15 @@ npm run create-video-thumbnails #### Issues - Video streaming does not always work, especially on Safari. -- PWA downloads does not work on iOS. +- PWA downloads does not work on iOS (This may be a current iOS limitation and not a myDrive issue). - Upload folder will sometimes fail on complex folder structures. - Generating video thumbnails with the default method will often fail, requiring the whole file to be downloaded to temporary storage and then the thumbnail generated from that. #### Future improvments - An alternative to using mongoDB +- Dark mode +- Enhance service worker, currently only caches thumbnails. This includes potentially adding offline support. - Typescript type cleanup - Better error handling - Logging diff --git a/src/config/.env.development.example b/src/config/.env.development.example index 593bf41..fe4427f 100644 --- a/src/config/.env.development.example +++ b/src/config/.env.development.example @@ -1 +1,11 @@ -VITE_BACKEND_URL=http://localhost:5173/api \ No newline at end of file +# Optional, useful for development or if your BE is on a different domain +# Example: http://localhost:5173/api +VITE_BACKEND_URL= + +# Optional, this one is only used in development +# /api will be appended to this URL, so for example +# Here our BE is on localhost:3000, and we are telling +# Vite to proxy all requests to /api to our BE +# Proxy, and URL will become http://localhost:5173/api in this case. +# Example: http://localhost:3000 +VITE_PROXY_URL= \ No newline at end of file diff --git a/src/config/.env.production.example b/src/config/.env.production.example index 593bf41..c8fc3ca 100644 --- a/src/config/.env.production.example +++ b/src/config/.env.production.example @@ -1 +1,16 @@ -VITE_BACKEND_URL=http://localhost:5173/api \ No newline at end of file +# NOTE: You most likely do not need these unless you running in development mode. + +# Either remove the .example from the end of this filename. +# Or create a new file with the same name, but without the .example extension. + +# Optional, useful for development or if your BE is on a different domain +# Example: http://localhost:5173/api +VITE_BACKEND_URL= + +# Optional, this one is only used in development +# /api will be appended to this URL, so for example +# Here our BE is on localhost:3000, and we are telling +# Vite to proxy all requests to /api to our BE +# Proxy, and URL will become http://localhost:5173/api in this case. +# Example: http://localhost:3000 +VITE_PROXY_URL= \ No newline at end of file