jmalcloud-view/README_en_US.md
2023-05-31 15:21:21 +08:00

87 lines
3.2 KiB
Markdown
Raw Blame History

This file contains ambiguous Unicode characters

This file contains Unicode characters that might be confused with other characters. If you think that this is intentional, you can safely ignore this warning. Use the Escape button to reveal them.

# JmalCloud Personal Netdisk | [中文](https://github.com/jamebal/jmal-cloud-view/blob/master/README.md)
JmalCloud It's a private cloud storage project that makes it simple and secure to manage your files in the cloud
✅ Support OSS, Alibaba Cloud OSS and Tencent Cloud OSS
✅ Supports online preview of images, audio, video and other files
✅ Supports editing and previewing of Word, Excel, PPT, process and mind map
✅ support x86, arm64 (Centos/Debian/Ubuntu/macOS)
✅ provides a powerful online text editor
✅ Supports large file uploading and resumable uploading
✅ supports WebDAV
### Online Demo:
[View Demo](https://jmal.cc/demo) , username:demo, password:demo1234
### deployment(Recommend)
[docker deployment](https://jmal.cc/mv572)
- You must install: 'Docker' and 'Docker Compose V2.0 +'
```shell
# 1、Clone the project to your local or server
git clone --depth=1 https://github.com/jamebal/jmal-cloud-server.git
# Or
git clone --depth=1 https://gitee.com/jmal/jmal-cloud-server.git
# 2、Enter the directory
cd jmal-cloud-server
# 3、A key to install
./jc.sh install
# 4、Update
./jc.sh pull
./jc.sh update
```
[Other ways deployment](https://jmal.cc/b75gm)
### Dev
#### Environment Requirements:
- jdk17+
- mongodb4.4+
- node v16.x.x
##### 1. Clone the server-side project
`git clone https://github.com/jamebal/jmal-cloud-server.git`
##### 2. Modify the configuration file `src/main/resources/file.yml`
Change the parameters `rootDir` and `ip2region-db-path` to your own directory and start the service
##### 3. Clone the web-side project
`git clone https://github.com/jamebal/jmal-cloud-view.git`
##### 4. Run `npm install` in the project directory
##### 5. Start the web-side with `npm run dev`
### Some screenshots:
![image0](https://www.jmal.top/api/file/jmal/jmalcloud/releases/%E6%88%AA%E5%B1%8F%20192.png)
![image1](./doc/%E6%88%AA%E5%B1%8F%2028.png)
![image2](./doc/%E6%88%AA%E5%B1%8F%2029.png)
![image3](./doc/%E6%88%AA%E5%B1%8F%2030.png)
![image4](./doc/%E6%88%AA%E5%B1%8F%2031.png)
![image5](./doc/%E6%88%AA%E5%B1%8F%2032.png)
![image6](./doc/%E6%88%AA%E5%B1%8F%2033.png)
### Browser Support
| [<img src="https://raw.githubusercontent.com/alrra/browser-logos/master/src/edge/edge_48x48.png" alt="IE / Edge" width="24px" height="24px" />](http://godban.github.io/browsers-support-badges/)</br>IE / Edge | [<img src="https://raw.githubusercontent.com/alrra/browser-logos/master/src/firefox/firefox_48x48.png" alt="Firefox" width="24px" height="24px" />](http://godban.github.io/browsers-support-badges/)</br>Firefox | [<img src="https://raw.githubusercontent.com/alrra/browser-logos/master/src/chrome/chrome_48x48.png" alt="Chrome" width="24px" height="24px" />](http://godban.github.io/browsers-support-badges/)</br>Chrome | [<img src="https://raw.githubusercontent.com/alrra/browser-logos/master/src/safari/safari_48x48.png" alt="Safari" width="24px" height="24px" />](http://godban.github.io/browsers-support-badges/)</br>Safari |
| --------- | --------- | --------- | --------- |
| IE10, IE11, Edge| last 2 versions| last 2 versions| last 2 versions
### Follow-up Updates
- [ ] iOS APP
- [ ] Android APP
- [ ] PC
### Permission
[MIT](https://github.com/jamebal/jmal-cloud-view/blob/master/LICENSE) license.
Copyright (c) 2020-present jmal