tonybark.com/README.md

37 lines
935 B
Markdown
Raw Normal View History

2024-12-03 10:07:06 -08:00
# WhiteBreeze
A small frontend for [WhiteWind](https://whtwnd.com/), a MarkDown blog service using [ATProto](https://atproto.com/).
WhiteBreeze targets a single user and is meant for someone to self-host their WhiteWind blog posts, without having to direct users to the WhiteWind website.
## Usage
2024-12-03 10:46:06 -08:00
### Development
2024-12-03 10:07:06 -08:00
```sh
npm install
npm run dev
```
2024-12-03 10:46:06 -08:00
### Production
2024-12-03 10:07:06 -08:00
Change environment variables:
```sh
PUBLIC_HANDLE="myhandle.bsky.social" # Your handle, or DID
PUBLIC_ABOUT="Welcome to my blog!" # Optional description of the kinds of posts you'll be making, or a greeting.
# PUBLIC_ABOUT Shows up under your Bluesky profile description in the profile card.
```
2024-12-03 10:46:06 -08:00
#### Standalone
2024-12-03 10:07:06 -08:00
```
npm install
2024-12-03 10:10:54 -08:00
npm run build
node index.js
```
2024-12-03 10:46:06 -08:00
Put environment variables ahead of the last command, port can also be configured with `PORT`.
#### Dockerized
Modify `docker-compose.yaml` and change the host port if necessary.
```
docker compose up
```