hamstr/README.md

59 lines
1.1 KiB
Markdown
Raw Normal View History

2022-05-24 02:13:09 +00:00
# astral
2022-05-24 02:13:09 +00:00
[astral](https://astral.ninja) is a web client for interacting with [Nostr](https://github.com/fiatjaf/nostr), a protocol that attempts to make decentralized social media a reality. astral began as a fork of [Branle](https://github.com/fiatjaf/branle).
2022-01-15 21:12:24 +00:00
## Install the dependencies
```bash
yarn
2022-05-24 02:13:09 +00:00
# or
npm install
```
### 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
```
### Lint the files
```bash
2022-05-29 23:15:34 +00:00
yarn lint
# or
npm run lint
```
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:
```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
```
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
2022-05-24 02:13:09 +00:00
docker build -t astral .
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
2022-05-24 02:13:09 +00:00
docker run -d -p 8080:8000 --name astral astral
2022-01-22 17:03:42 +00:00
```
2022-05-24 02:13:09 +00:00
and connect to 'http://localhost:8080/'