https://github.com/aelithron/writers-block
A simple writing webapp with powerful features.
https://github.com/aelithron/writers-block
books fanfic minimalist nextjs writing
Last synced: about 1 month ago
JSON representation
A simple writing webapp with powerful features.
- Host: GitHub
- URL: https://github.com/aelithron/writers-block
- Owner: aelithron
- License: mit
- Created: 2025-06-02T23:08:59.000Z (about 1 year ago)
- Default Branch: main
- Last Pushed: 2026-05-13T01:16:09.000Z (2 months ago)
- Last Synced: 2026-05-28T00:28:06.291Z (about 2 months ago)
- Topics: books, fanfic, minimalist, nextjs, writing
- Language: TypeScript
- Homepage: https://wb.novatea.dev
- Size: 211 KB
- Stars: 0
- Watchers: 0
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# Writer's Block
A simple writing webapp for books, fanfiction, and short stories.
## Features
- Settings for chaptered vs short stories
- Simple writing UI
- Protection from losing work (autosaving + others)
- Plaintext exporting
### Planned Features
- Rich text editor
- EPub/PDF/Docx exporting
- Book planning tool (with templates)
## Usage
Using Writer's Block is simple! Just go to [wb.novatea.dev](https://wb.novatea.dev) and sign in with Google (or if you're in Hack Club, you can use Slack).
### Selfhosting
Selfhosting the app is a bit more complex, but can be done! I suggest using Docker, though I am sadly unable to provide a prebuilt image for now.
1. Environment Variables
Set up the following environment variables:
- `MONGODB_URI`: A MongoDB connection string to your database server.
- `MONGODB_DB`: The name of your database. Make sure it contains a collection called `stories`!
- `AUTH_SECRET`: A random string to secure user sessions. You can generate this with the command `openssl rand -base64 33` on Linux.
- `AUTH_GOOGLE_ID` and `AUTH_GOOGLE_SECRET`: A Google Cloud OAuth ID and Secret. This will enable Google login. You can configure this [on Google Cloud Console](https://console.cloud.google.com/auth/overview), make sure to create a project and follow their setup. Your redirect URI is `https://[domain].[tld]/api/auth/callback/google`.
- `AUTH_SLACK_ID` and `AUTH_SLACK_SECRET`: Optional, a Slack OAuth ID and Secret. Just like above, this enables Slack login. You can create a Slack app and add it's ID and secret here. No links are provided, as it's a complicated process to set up. Your redirect URL is `https://[domain].[tld]/api/auth/callback/slack`.
2. You can use either of the below methods to quickly deploy.
**Make sure to fill in the empty quotation marks with the environment variables from step 1!**
Also, optional variables are commented out, but you can uncomment them to use them.
#### With Docker Compose
Copy the following Compose file to your server or computer, and name it `compose.yaml`:
```yaml
services:
writers-block:
image: ghcr.io/aelithron/writers-block:latest
container_name: writers-block
restart: unless-stopped
environment:
MONGODB_URI: ""
MONGODB_DB: ""
AUTH_SECRET: ""
AUTH_URL: ""
AUTH_GOOGLE_ID: ""
AUTH_GOOGLE_SECRET: ""
# AUTH_SLACK_ID: ""
# AUTH_SLACK_SECRET: ""
ports:
- 3000:3000
```
Then, simply run `docker compose up -d` in the directory of the file!
#### With `docker run`
Run the following command on your server or computer:
```bash
docker run -d \
--name writers-block \
-p 3000:3000 \
-e MONGODB_URI="" \
-e MONGODB_DB="" \
-e AUTH_SECRET="" \
-e AUTH_URL="" \
-e AUTH_GOOGLE_ID="" \
-e AUTH_GOOGLE_SECRET="" \
# -e AUTH_SLACK_ID="" \
# -e AUTH_SLACK_SECRET="" \
--restart unless-stopped \
ghcr.io/aelithron/writers-block:latest
```
- Note: If you want to use something else (like Kubernetes), the Docker image can be found on the Packages tab (or simply pulled as `ghcr.io/aelithron/writers-block:latest`). Make sure to include the environment variables!
## Screenshot
## Extra Notes
The name "Writer's Block" is both based on the idea this app could help you get over actual writer's block, as well as that it's got most/all the tools a writer needs (as in, kinda like the equivalent to a corner store on an irl city block).