README.md

astral

astral is a web client for interacting with Nostr, a protocol that attempts to make decentralized social media a reality. astral began as a fork of Branle.

Install the dependencies

yarn
# or
npm install

Start the app in development mode (hot-code reloading, error reporting, etc.)

yarn dev
# or
npm run dev
# or if quasar installed locally
quasar dev

Lint the files

yarn lint
# or
npm run lint

Format the files

yarn format
# or
npm run format

Build the app for production in PWA mode:

yarn build:pwa
# or
npm run build:pwa
# or if quasar installed locally
quasar build -m pwa

Build the app for production in SPA mode:

yarn build:spa
# or
npm run build:spa
# or if quasar installed locally
quasar build

Docker

Build the docker image (uses PWA mode):

docker build -t astral .

Run the container:

docker run -d -p 8080:8000 --name astral astral

and connect to 'http://localhost:8080/'