readme fixes

This commit is contained in:
subnub
2025-02-25 15:30:40 -05:00
parent cec4b2ec66
commit f0aad6ffb7
+28 -10
View File
@@ -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)
<span id="features"></span>
## ⭐️ 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)
<span id="tech-stack"></span>
## 👨‍🔬 Tech Stack
- React
@@ -45,6 +49,8 @@ MyDrive is an Open Source cloud file storage server (Similar To Google Drive). H
- MongoDB
- Vite
<span id="installation"></span>
## 💻 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).
<span id="docker"></span>
## 🐳 Docker
Setup:
@@ -140,6 +148,8 @@ Setup:
npm run docker:production
```
<span id="screenshots"></span>
## 📸 Screenshots
Modern and colorful design
@@ -172,20 +182,28 @@ Move File/Folders
Trash
![Trash](github_images/trash.png)
<span id="video"></span>
## 🎥 Video
I created a short YouTube video, showing off myDrives design and features: (Coming soon)
<span id="live-demo"></span>
## 🕹️ 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.
<span id="bugs"></span>
## 👾 Bug reports and Feature Requests
Contact Email: kyle.hoell@gmail.com
<span id="updating"></span>
## ⬆️ 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.