{"id":13574060,"url":"https://github.com/btw-so/btw","last_synced_at":"2025-04-04T14:31:33.758Z","repository":{"id":153855245,"uuid":"605971272","full_name":"btw-so/btw","owner":"btw-so","description":"Open source Medium alternative- set up your personal blog in minutes.","archived":false,"fork":false,"pushed_at":"2024-02-23T05:48:20.000Z","size":27588,"stargazers_count":585,"open_issues_count":16,"forks_count":48,"subscribers_count":7,"default_branch":"main","last_synced_at":"2024-04-14T02:59:41.552Z","etag":null,"topics":["blog-platform","medium","no-code","note-taking","notes-app","personal-blog","website-builder"],"latest_commit_sha":null,"homepage":"https://btw.so","language":"JavaScript","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"gpl-3.0","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/btw-so.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null}},"created_at":"2023-02-24T09:57:18.000Z","updated_at":"2024-04-28T07:48:22.012Z","dependencies_parsed_at":"2023-10-17T01:37:14.567Z","dependency_job_id":"ba9bc0f7-2e59-41e7-9902-c393855a16b1","html_url":"https://github.com/btw-so/btw","commit_stats":null,"previous_names":[],"tags_count":0,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/btw-so%2Fbtw","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/btw-so%2Fbtw/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/btw-so%2Fbtw/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/btw-so%2Fbtw/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/btw-so","download_url":"https://codeload.github.com/btw-so/btw/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":247194059,"owners_count":20899424,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["blog-platform","medium","no-code","note-taking","notes-app","personal-blog","website-builder"],"created_at":"2024-08-01T15:00:45.846Z","updated_at":"2025-04-04T14:31:33.752Z","avatar_url":"https://github.com/btw-so.png","language":"JavaScript","readme":"![github-cover](https://user-images.githubusercontent.com/70569022/233320406-da81d842-c0d9-4d63-938e-fe521203e4e0.png)\n\n---\n\n# btw\n\n[btw](https://btw.so) is an open source personal website builder.\n\nYou can [sign up](https://btw.so) and use btw without installing anything. You can also use the open source version to self-host.\n\n![btw-editor-screenshot](https://user-images.githubusercontent.com/70569022/233320021-e05c995f-4e4e-48a9-83de-f578d3662df1.png)\n\n### Demo blogs published using btw:\n\n-   [dc.btw.so](https://dc.btw.so/)\n-   [siddg.com](https://www.siddg.com/about)\n\n## Table of contents\n\n-   [Getting Started](#getting-started)\n    -   [Pre-requisites](#pre-requisites)\n    -   [Installation](#installation)\n    -   [Development](#development)\n-   [Community](#community)\n-   [Coming next](#coming-next)\n-   [License](#license)\n\n## Getting started\n\nThese instructions will help you to get a copy of the project up and running on your local machine\n\n### Pre-requisites\n\n-   Install the latest version of Docker, Docker-compose on your system\n-   Working postgres instance\n-   SMTP credentials (Ex: from mailgun)\n\n### Installation\n\nSet 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:\n\n| Variable Name            | Description                                                                                                         |\n|--------------------------|---------------------------------------------------------------------------------------------------------------------|\n| TASKS_DATABASE_URL       | Connection URL to your PG DB (For development, the URL is already configured)                                                                                |\n| ADMIN_EMAIL              | Your email address (REQUIRED)                                                                                                  |\n| ADMIN_SLUG               | Unique slug (REQUIRED)                                                                                                         |\n| 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 |\n| SECRET                   | Unique secret (change the default secret)                                                                                                       |\n| SMTP_HOST                | SMTP HOST (OPTIONAL, used to email OTPs for login)                                                   |\n| SMTP_PORT                | OPTIONAL                                                                                                                  |\n| SMTP_USER                | OPTIONAL                                                                                                                    |\n| SMTP_PASS                | OPTIONAL                                                                                                                    |\n| SMTP_FROM                | OPTIONAL                                                                                                                    |\n| S3_ENDPOINT              | (OPTIONAL) Set this if you need image uploads to work in editor                                                                                                          |\n| REACT_APP_S3_ENDPOINT    | OPTIONAL                                                                                                                    |\n| S3_BUCKET                | OPTIONAL                                                                                                                    |\n| S3_KEY                   | OPTIONAL                                                                                                                    |\n| S3_SECRET                | OPTIONAL                                                                                                                   |\n\n### Development\n\n1. Execute the following commands from the deploy folder:\n    ```\n    docker-compose -f docker-compose.dev.yml up\n    ```\n2. Visit localhost:9000 to login and start writing\n3. If you set your slug and publish any articles, you can view them at localhost:9222?domain=\u003cadmin slug\u003e\n\n## Community\n\n-   [Twitter](https://twitter.com/btw_hq): Product updates \u0026 memes.\n-   [Discord](https://discord.com/invite/vbDysPXJuF): If you have questions or just want to hang out, come \u0026 say hi!\n\n## Coming next\n\n-   Simplified development setup\n-   Sample cloud deployment setup\n-   Sample custom domain setup instructions\n-   Feature roadmap\n-   Documentation\n-   Contributing guidelines\n\n## License\n\nSee the [LICENSE](https://github.com/btw-so/btw/blob/main/LICENSE) file for details.\n","funding_links":[],"categories":["HarmonyOS","others","JavaScript","Open Source","E-Commerce \u0026 Business","Web"],"sub_categories":["Windows Manager","Electron","Blogging platform/ Personal website builder (Medium alternatives)"],"project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fbtw-so%2Fbtw","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fbtw-so%2Fbtw","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fbtw-so%2Fbtw/lists"}