onyx/onyx-web-app/README.md

32 lines
559 B
Markdown
Raw Normal View History

2023-10-25 19:59:35 +00:00
# onyx-web-app
A Vue3/Typescript web application for interacting with an Onyx node. Its
purpose is to let users:
- Login or register an account with the node, if the owner allows it.
- View the hierarchical content tree of the node.
- Edit individual content, and change access permissions where allowed.
## Project Setup
```sh
npm install
```
### Compile and Hot-Reload for Development
```sh
npm run dev
```
### Type-Check, Compile and Minify for Production
```sh
npm run build
```
### Lint with [ESLint](https://eslint.org/)
```sh
npm run lint
```