2023-01-01 23:21:32 +00:00
|
|
|
# Hamstr
|
2021-12-10 14:03:45 +00:00
|
|
|
|
2023-01-01 23:21:32 +00:00
|
|
|
[Hamstr](https://hamstr.to) is a twitter-style [Nostr](https://github.com/fiatjaf/nostr) web client.
|
|
|
|
It is a fork of [astral](https://github.com/monlovesmango/astral), which itself started as a fork of [branle](https://github.com/fiatjaf/branle).
|
2022-01-15 21:12:24 +00:00
|
|
|
|
2021-12-10 14:03:45 +00:00
|
|
|
## Install the dependencies
|
|
|
|
```bash
|
|
|
|
yarn
|
2022-05-24 02:13:09 +00:00
|
|
|
# or
|
|
|
|
npm install
|
2021-12-10 14:03:45 +00:00
|
|
|
```
|
|
|
|
|
|
|
|
### Start the app in development mode (hot-code reloading, error reporting, etc.)
|
|
|
|
```bash
|
2022-05-29 23:15:34 +00:00
|
|
|
quasar dev
|
|
|
|
# or if quasar is not installed globally
|
2022-05-13 16:16:56 +00:00
|
|
|
./node_modules/.bin/quasar dev
|
2021-12-10 14:03:45 +00:00
|
|
|
```
|
|
|
|
|
|
|
|
### Lint the files
|
|
|
|
```bash
|
2022-05-29 23:15:34 +00:00
|
|
|
yarn lint
|
|
|
|
# or
|
|
|
|
npm run lint
|
2021-12-10 14:03:45 +00:00
|
|
|
```
|
2022-05-24 02:13:09 +00:00
|
|
|
### Format the files
|
|
|
|
```bash
|
|
|
|
yarn format
|
|
|
|
# or
|
|
|
|
npm run format
|
|
|
|
```
|
|
|
|
|
2022-12-03 05:05:15 +00:00
|
|
|
### Build the app for production in PWA mode:
|
|
|
|
```bash
|
|
|
|
quasar build -m pwa
|
|
|
|
# or if quasar is not installed globally
|
|
|
|
./node_modules/.bin/quasar build -m pwa
|
|
|
|
```
|
|
|
|
|
|
|
|
### Build the app for production in SPA mode:
|
2021-12-10 14:03:45 +00:00
|
|
|
```bash
|
2022-05-29 23:15:34 +00:00
|
|
|
quasar build
|
|
|
|
# or if quasar is not installed globally
|
2022-05-13 16:16:56 +00:00
|
|
|
./node_modules/.bin/quasar build
|
2021-12-10 14:03:45 +00:00
|
|
|
```
|
|
|
|
|
2022-01-22 17:03:42 +00:00
|
|
|
## Docker
|
|
|
|
|
2022-12-03 05:05:15 +00:00
|
|
|
### Build the docker image (uses PWA mode):
|
2022-01-22 17:03:42 +00:00
|
|
|
```bash
|
2023-01-01 23:21:32 +00:00
|
|
|
docker build -t hamstr .
|
2022-01-22 17:03:42 +00:00
|
|
|
```
|
|
|
|
|
2022-12-03 05:05:15 +00:00
|
|
|
### Run the container:
|
2022-01-22 17:03:42 +00:00
|
|
|
```bash
|
2023-01-01 23:21:32 +00:00
|
|
|
docker run -d -p 8080:8000 --name hamstr hamstr
|
2022-01-22 17:03:42 +00:00
|
|
|
```
|
|
|
|
|
2022-05-24 02:13:09 +00:00
|
|
|
and connect to 'http://localhost:8080/'
|