AquaDX/AquaNet/README.md

21 lines
588 B
Markdown
Raw Permalink Normal View History

2024-02-10 19:43:01 +08:00
# AquaNet
2024-02-08 09:13:53 +08:00
2024-02-10 19:43:01 +08:00
This is the codebase for the new frontend of AquaDX.
This project is also heavily WIP, so more details will be added later on.
2024-02-08 09:13:53 +08:00
2024-02-10 19:43:01 +08:00
## Development
2024-02-08 09:13:53 +08:00
2024-12-24 07:32:02 +08:00
This project uses Svelte (NOT SvelteKit) + TypeScript + Sass, built using Vite. The preferred editor is VSCode.
2024-02-08 09:13:53 +08:00
2024-02-10 19:43:01 +08:00
### Running locally
2024-02-08 09:13:53 +08:00
2024-12-24 07:32:02 +08:00
First, you would need to install Node.js and bun.
2024-02-13 00:26:37 +08:00
Then, you would need to start your testing AquaDX server and configure the `aqua_host` in `src/libs/config.ts` to use your URL.
Please leave `data_host` unchanged if you're not sure what it is.
2024-02-10 19:43:01 +08:00
Finally, run:
2024-02-08 09:13:53 +08:00
2024-02-10 19:43:01 +08:00
```shell
2024-12-24 07:32:02 +08:00
bun install
bun run dev
2024-02-08 09:13:53 +08:00
```