Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/btw-so/btw
Open source Medium alternative- set up your personal blog in minutes.
https://github.com/btw-so/btw
blog-platform medium no-code note-taking notes-app personal-blog website-builder
Last synced: about 1 month ago
JSON representation
Open source Medium alternative- set up your personal blog in minutes.
- Host: GitHub
- URL: https://github.com/btw-so/btw
- Owner: btw-so
- License: gpl-3.0
- Created: 2023-02-24T09:57:18.000Z (almost 2 years ago)
- Default Branch: main
- Last Pushed: 2024-02-23T05:48:20.000Z (10 months ago)
- Last Synced: 2024-04-14T02:59:41.552Z (8 months ago)
- Topics: blog-platform, medium, no-code, note-taking, notes-app, personal-blog, website-builder
- Language: JavaScript
- Homepage: https://btw.so
- Size: 26.3 MB
- Stars: 585
- Watchers: 7
- Forks: 48
- Open Issues: 16
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
- awesome-foss-alternatives - btw - Open source Medium alternative- set up your personal blog in minutes. [JS, GNU General Public License v3.0]. (Web / Blogging platform/ Personal website builder (Medium alternatives))
- jimsghstars - btw-so/btw - Open source Medium alternative- set up your personal blog in minutes. (JavaScript)
README
---
# btw
[btw](https://btw.so) is an open source personal website builder.
You can [sign up](https://btw.so) and use btw without installing anything. You can also use the open source version to self-host.
### Demo blogs published using btw:
- [deeptichopra.com](https://www.deeptichopra.com/about)
- [siddg.com](https://www.siddg.com/about)
## Table of contents
- [Getting Started](#getting-started)
- [Pre-requisites](#pre-requisites)
- [Installation](#installation)
- [Development](#development)
- [Community](#community)
- [Coming next](#coming-next)
- [License](#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
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 |
### 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](https://twitter.com/btw_hq): Product updates & memes.
- [Discord](https://discord.com/invite/vbDysPXJuF): 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](https://github.com/btw-so/btw/blob/main/LICENSE) file for details.