btw is an open source personal website builder.
You can sign up and use btw without installing anything. You can also use the open source version to self-host.
These instructions will help you to get a copy of the project up and running on your local machine
- Install the latest version of Docker, Docker-compose on your system
- Working postgres instance
- SMTP credentials (Ex: from mailgun)
Set ADMIN_EMAIL and ADMIN_SLUG in deploy/docker-compose.dev.yml. These are the only mandatory fields. Your database will be automatically configured on the first setup. Details of other variables in the docker-compose file:
| Variable Name | Description |
|---|---|
| TASKS_DATABASE_URL | Connection URL to your PG DB (For development, the URL is already configured) |
| ADMIN_EMAIL | Your email address (REQUIRED) |
| ADMIN_SLUG | Unique slug (REQUIRED) |
| ADMIN_OTP | (OPTIONAL) Set a unique 6 digit code, if you want the writer to be behind OTP login. OTP login turned off by default |
| SECRET | Unique secret (change the default secret) |
| SMTP_HOST | SMTP HOST (OPTIONAL, used to email OTPs for login) |
| SMTP_PORT | OPTIONAL |
| SMTP_USER | OPTIONAL |
| SMTP_PASS | OPTIONAL |
| SMTP_FROM | OPTIONAL |
| S3_ENDPOINT | (OPTIONAL) Set this if you need image uploads to work in editor |
| REACT_APP_S3_ENDPOINT | OPTIONAL |
| S3_BUCKET | OPTIONAL |
| S3_KEY | OPTIONAL |
| S3_SECRET | OPTIONAL |
- Execute the following commands from the deploy folder:
docker-compose -f docker-compose.dev.yml up - Visit localhost:9000 to login and start writing
- If you set your slug and publish any articles, you can view them at localhost:9222?domain=
- Twitter: Product updates & memes.
- Discord: If you have questions or just want to hang out, come & say hi!
- Simplified development setup
- Sample cloud deployment setup
- Sample custom domain setup instructions
- Feature roadmap
- Documentation
- Contributing guidelines
See the LICENSE file for details.