https://github.com/deadbits/qubit
Minimalist blogging
https://github.com/deadbits/qubit
blogging microblog publishing
Last synced: 11 months ago
JSON representation
Minimalist blogging
- Host: GitHub
- URL: https://github.com/deadbits/qubit
- Owner: deadbits
- Created: 2024-12-30T21:21:46.000Z (about 1 year ago)
- Default Branch: main
- Last Pushed: 2024-12-30T22:48:00.000Z (about 1 year ago)
- Last Synced: 2024-12-30T23:25:39.766Z (about 1 year ago)
- Topics: blogging, microblog, publishing
- Language: Python
- Homepage: https://qubit.deadbits.ai
- Size: 1000 KB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# qubit
> A qubit (/ˈkjuːbɪt/) or quantum bit is a basic unit of quantum information.
* **[Quick Start](https://qubit.deadbits.ai/getting-started/quickstart)**
* **[Manual Install](https://qubit.deadbits.ai/getting-started/manual-install)**
* **[Screenshots](https://qubit.deadbits.ai/getting-started/screenshots)**
Qubit is a minimalist blogging and micro-blogging platform that can be easily self-hosted.
Modern social platforms shape how we write and share. But sometimes you just want a quiet corner of the internet to document your thoughts and learnings.
Inspired by the simplicity of "Today I Learned" blogs and the clean aesthetics of platforms like [WriteFreely](https://writefreely.org/) and [Article.app](https://article.app/), Qubit is built for developers and tinkerers who want to focus on writing without the pressure of metrics, algorithms, or engagement statistics.
Write short notes about what you're building. Share useful resources you've discovered. Document your learning journey.
No follower counts, no likes, no retweets — just thoughts and code in clean, monospaced type.
> [!NOTE]
> This project was built in two days over the holiday break. Although I built it deployment in mind, _you_ probably shouldn't deploy it publicly. There may be bugs or security issues.
## ✨ Features
- Clean, distraction-free writing experience
- Markdown editor with live preview
- Tag-based organization
- Full text search
- Modern, minimal frontend
## 🚀 Quick Start
Follow the quick start guide below to run Qubit with Docker compose, or full the manual installation steps on [the documenation site](https://qubit.deadbits.ai).
1. Clone the repository
```bash
git clone https://github.com/deadbits/qubit
cd qubit
```
2. Create a `.env` file in project root directory
```bash
# docker/.env
DB_PASSWORD=your_secure_password_here
AUTH_SECRET_KEY=your_secret_key_here
ADMIN_USERNAME=admin
ADMIN_EMAIL=admin@example.com
ADMIN_PASSWORD=your_admin_password
```
3. Configure your author details in `data/config.yaml`
The `data/config.yaml` file controls your blog's author details and bio on the `About` page.
```yaml
author:
name: Adam Swanda
short_name: adam
bio: >
Security researcher and developer focused on AI/ML security, threat intelligence, and building tools that help people research and create.
github: deadbits
website: https://www.deadbits.org
linkedin: https://www.linkedin.com/in/adamswanda/
```
4. Start the application with Docker
```bash
docker compose up -d --build
```
That's it! You can login to Qubit at [http://localhost:8000/login](http://localhost:8000/login).