sriharshamajeti/btw

Open source personal website builder. Set up your website within minutes.

---

btw

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.

Demo blogs published using btw:

• deeptichopra.com
• siddg.com

Table of contents

• Getting Started
  • Pre-requisites
  • Installation
  • Development
• Community
• Coming next
• License

Getting started

These instructions will help you to get a copy of the project up and running on your local machine

Pre-requisites

• Install the latest version of Docker, Docker-compose on your system
• Working postgres instance
• SMTP credentials (Ex: from mailgun)

Installation

1. Setup your database using btw.sql file
2. Replace the variables in deploy/docker-compose.dev.yml

Variable Name	Description
TASKS_DATABASE_URL	Set the connection URL to your PG DB
ADMIN_EMAIL	Your email address
ADMIN_SLUG	Unique slug
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
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

Development

1. Execute the following commands from the deploy folder:

   docker-compose -f docker-compose.dev.yml up
   

2. Visit localhost:9000 to login and start writing
3. If you set your slug and publish any articles, you can view them at localhost:9222?domain=

Community

• Twitter: Product updates & memes.
• Discord: If you have questions or just want to hang out, come & say hi!

Coming next

• Simplified development setup
• Sample cloud deployment setup
• Sample custom domain setup instructions
• Feature roadmap
• Documentation
• Contributing guidelines

License

See the LICENSE file for details.