HomeDisk/README.md

37 lines
1.4 KiB
Markdown
Raw Normal View History

2022-04-16 18:19:38 +00:00
# HomeDisk cloud server
2022-08-18 20:49:41 +00:00
> **Warning**
> Currently, work on the project is suspended because I'm not good at frontend and don't have time :(
2022-06-12 13:58:07 +00:00
[docs-rs]: https://img.shields.io/badge/docs.rs-66c2a5?style=for-the-badge&labelColor=555555&logo=docs.rs
[total-lines]: https://img.shields.io/tokei/lines/github/MedzikUser/HomeDisk?style=for-the-badge&logo=github&color=fede00
[code-size]: https://img.shields.io/github/languages/code-size/MedzikUser/HomeDisk?style=for-the-badge&color=c8df52&logo=github
2022-06-16 12:15:37 +00:00
[ci]: https://img.shields.io/github/workflow/status/MedzikUser/HomeDisk/Rust/main?style=for-the-badge
2022-06-08 19:46:09 +00:00
2022-08-15 10:11:32 +00:00
[screenshot-home]: https://raw.githubusercontent.com/HomeDisk/.github/main/screenshots/home.png
[screenshot-login]: https://raw.githubusercontent.com/HomeDisk/.github/main/screenshots/login.png
[![docs-rs]](https://homedisk-doc.vercel.app)
[![total-lines]](https://github.com/MedzikUser/HomeDisk)
[![code-size]](https://github.com/MedzikUser/HomeDisk)
2022-06-16 12:15:37 +00:00
[![ci]](https://github.com/MedzikUser/HomeDisk/actions/workflows/rust.yml)
2022-05-22 10:28:43 +00:00
2022-07-04 11:42:58 +00:00
![screenshot-home]
![screenshot-login]
2022-05-22 10:28:43 +00:00
2022-05-22 11:17:26 +00:00
## 👨‍💻 Building
First clone the repository: `git clone https://github.com/MedzikUser/HomeDisk.git`
2022-05-22 11:17:26 +00:00
### Requirements
2022-05-22 11:17:26 +00:00
- Rust
To build run the command: `cargo build --release`
The compiled binary can be found in `./target/release/homedisk`
2022-05-22 11:17:26 +00:00
## Configure
2022-05-22 11:17:26 +00:00
Go to [config](https://homedisk-doc.medzik.xyz/homedisk_types/config) module