diff --git a/README.md b/README.md index d7673e3..eca25e0 100644 --- a/README.md +++ b/README.md @@ -1,3 +1,57 @@ -# DevBin +
+

DevBin

+

A minimalist, self-hosted, code-sharing platform.

+ +

+ Next.js + SQLite + Tailwind +

+
-Pastebin \ No newline at end of file +--- + +## ⚡ Features + +- **Pro Editor**: Powered by Monaco (the engine behind VS Code) with full syntax highlighting. +- **Privacy First**: Set pastes to "Burn on Read" or expire after a specific duration. +- **Clean Slate**: No default text or placeholders—just a professional dark-mode coding environment. +- **Self-Destruct Control**: Each paste generates a unique deletion token stored locally in your browser, allowing the creator to delete it instantly. +- **Optional Discussions**: Toggle Markdown-supported comments for collaborative debugging. +- **Zero Configuration**: Uses SQLite, so there's no complex database setup required. + +## 🛠️ Tech Stack + +- **Framework**: [Next.js](https://nextjs.org/) +- **Editor**: [Monaco Editor](https://microsoft.github.io/monaco-editor/) +- **Database**: [SQLite](https://www.sqlite.org/) (via `better-sqlite3`) +- **Styling**: [Tailwind CSS](https://tailwindcss.com/) +- **Icons/IDs**: [Nanoid](https://github.com/ai/nanoid) + +## 🚀 Getting Started + +### Prerequisites +- Node.js 18.x or later +- Yarn or NPM + +### Installation + +1. **Clone the repository:** + ```bash + git clone --recurse-submodules https://gitea.0bin.xyz/pegasus/DevBin.git + cd devbin + ``` +2. **Install dependencies:** + ``` + yarn install + ``` +3. **Run in Development:** + ``` + yarn next dev -p 3001 + ``` +4. **Build for Production:** + ``` + yarn build + yarn start -p 3001 + ``` +The database (devbin.db) will be automatically initialized on the first run. \ No newline at end of file