Skip to content
Snippets Groups Projects
README.md 978 B
Newer Older
Jan den Besten's avatar
Jan den Besten committed
# Pubhubs Client
Jan den Besten's avatar
Jan den Besten committed
A [PubHubs](https://pubhubs.net/) client for a better user experience with the PubHubs network as Matrix Element could give us.

Jan den Besten's avatar
Jan den Besten committed
Build on top of `matrix-js-sdk` with `TypeScript`, `VueJs3` and `Tailwind`.
Jan den Besten's avatar
Jan den Besten committed

Jan den Besten's avatar
Jan den Besten committed
# Installing
Jan den Besten's avatar
Jan den Besten committed

Jan den Besten's avatar
Jan den Besten committed
For normal use this should automically be done with the PubHubs deployment and install procedure.
Jan den Besten's avatar
Jan den Besten committed
# Development

[Node](https://nodejs.org) should be present on you're system.
Jan den Besten's avatar
Jan den Besten committed

```
Jan den Besten's avatar
Jan den Besten committed
```

Jan den Besten's avatar
Jan den Besten committed
Set url of the hubs-homeserver in `.env`:

```
VUE_APP_BASEURL = https://....
```


## Theming components

Theming can be changed in: `./src/assets/pubhubs-theme.js`.

Show and test the components (we use [histoire](https://histoire.dev)):
Jan den Besten's avatar
Jan den Besten committed

```
npm run story:dev
```

Icons (svg) are all in one TypeScript object (strings) in `./src/assets/icons.ts`
Jan den Besten's avatar
Jan den Besten committed

## Development

Jan den Besten's avatar
Jan den Besten committed

Jan den Besten's avatar
Jan den Besten committed
## Production

Jan den Besten's avatar
Jan den Besten committed

Jan den Besten's avatar
Jan den Besten committed
As a PWA:

```
npm run pwa
```

Jan den Besten's avatar
Jan den Besten committed
## Testing
Jan den Besten's avatar
Jan den Besten committed

```
npm run test
```

Jan den Besten's avatar
Jan den Besten committed
## Lints and fixes files