diff --git a/readme.md b/readme.md index ce0ed5c..9b809b7 100755 --- a/readme.md +++ b/readme.md @@ -8,15 +8,17 @@ MyDrive is an Open Source cloud file storage server (Similar To Google Drive). H ## 🔍 Index -- [Features](#â­ī¸-features) -- [Tech stack](#👨‍đŸ”Ŧ-tech-stack) -- [Installation (non docker)](#đŸ’ģ-installation) -- [Docker](#đŸŗ-docker) -- [Screenshots](#📸-screenshots) -- [Video](#đŸŽĨ-video) -- [Live demo](#đŸ•šī¸-live-demo) -- [Feature requests/bug reports](#👾-bug-reports-and-feature-requests) -- [Updating from a previous version of myDrive](#âŦ†ī¸-updating-from-a-previous-version-of-mydrive) +- [Features](#features) +- [Tech stack](#tech-stack) +- [Installation (non docker)](#installation) +- [Docker](#docker) +- [Screenshots](#screenshots) +- [Video](#video) +- [Live demo](#live-demo) +- [Feature requests/bug reports](#bugs) +- [Updating from a previous version of myDrive](#updating) + + ## â­ī¸ Features @@ -36,6 +38,8 @@ MyDrive is an Open Source cloud file storage server (Similar To Google Drive). H - Email Verification - JWT (Access and Refresh Tokens) + + ## 👨‍đŸ”Ŧ Tech Stack - React @@ -45,6 +49,8 @@ MyDrive is an Open Source cloud file storage server (Similar To Google Drive). H - MongoDB - Vite + + ## đŸ’ģ Installation Required: @@ -120,6 +126,8 @@ NODE_OPTIONS="--max-old-space-size=4096" npm run build You can read more about this issue [here](https://stackoverflow.com/questions/38558989/node-js-heap-out-of-memory). + + ## đŸŗ Docker Setup: @@ -140,6 +148,8 @@ Setup: npm run docker:production ``` + + ## 📸 Screenshots Modern and colorful design @@ -172,20 +182,28 @@ Move File/Folders Trash ![Trash](github_images/trash.png) + + ## đŸŽĨ Video I created a short YouTube video, showing off myDrives design and features: (Coming soon) + + ## đŸ•šī¸ Live demo Demo: http://143.244.181.219:3000/ -- Note: Creating, deleting and other features are disabled in the demo. +Note: Creating, deleting and other features are disabled in the demo. + + ## 👾 Bug reports and Feature Requests Contact Email: kyle.hoell@gmail.com + + ## âŦ†ī¸ Updating from a previous version of myDrive If you are upgrading from myDrive 3 there is some data migration and scripts you must run for myDrive 4 to work properly.