HomeDisk/README.md

46 lines
1.5 KiB
Markdown

# HomeDisk cloud server
[![docs](https://img.shields.io/badge/docs-rust_docs-fff)](https://homedisk-doc.vercel.app/cloud/)
[![license badge](https://img.shields.io/github/license/MedzikUser/HomeDisk)](https://github.com/MedzikUser/HomeDisk)
[![code size badge](https://img.shields.io/github/languages/code-size/MedzikUser/HomeDisk)](https://github.com/MedzikUser/HomeDisk)
[![total lines badge](https://img.shields.io/tokei/lines/github/MedzikUser/HomeDisk)](https://github.com/MedzikUser/HomeDisk)
[![Build release binaries (and publish them if this is a tag)](https://github.com/MedzikUser/HomeDisk/actions/workflows/build-release-binaries.yml/badge.svg)](https://github.com/MedzikUser/HomeDisk/actions/workflows/build-release-binaries.yml)
![](https://i.imgur.com/gi7KBVE.png)
![](https://i.imgur.com/vLautmq.png)
## 👨‍💻 Building
### Server
#### Requirements
- Rust
To build run the command: `cargo build --release`
The compiled binary can be found in `./target/release/cloud`
### Website
#### Requirements
- Node.js
- pnpm
Run these commands to build:
- Go to directory `./website`
- Install dependencies: `pnpm install`
- Build website: `pnpm run build`
- Export website to static HTML files: `pnpm run export` (Optional)
If you exported the page to HTML files, they are located in the `./out` directory,
if not, you can start the site with `pnpm run start`
## 🖴 Creating tables in a SQLite database
#### Requirements
- SQLite3
Run command `sqlite3 homedisk.db < tables.sql` to create SQLite database