AquaDX/AquaNet/README.md
2024-02-12 18:04:56 +01:00

22 lines
637 B
Markdown

# AquaNet
This is the codebase for the new frontend of AquaDX.
This project is also heavily WIP, so more details will be added later on.
## Development
This project uses Svelte (NOT SvelteKit) + TypeScript + Sass, built using Vite.
The preferred editor is IntelliJ IDEA, but VSCode can pass as well.
Please check out [SVELTE.md](SVELTE.md) for more details on the technical aspects of the project.
### Running locally
First, you would need to install Node.js and yarn.
Then, you would need to start your testing AquaDX server and configure the `src/libs/config.ts` to use your URL.
Finally, run:
```shell
yarn install
yarn dev
```