diff --git a/README.md b/README.md index fc77e09..40c5d73 100644 --- a/README.md +++ b/README.md @@ -1,8 +1,89 @@ -# **contentport — public roadmap (last updated: 29th Nov 2025)** + +

+ + Contentport Logo + + +

Contentport

+ +

+ Your content engine for growing on Twitter +
+ Create and schedule Twitter content at scale » +
+
+ Website + · + Features + · + Issues + · + Pricing +

+

+ +

+ Website + Twitter + Open Source +

+ +

+ Github Stars + License +

-## **Features in Pipeline** +--- + +# contentport + +## Getting Started + +> **Note:** This is a WIP and not comprehensive. Please contribute an improvement if you want to help others get started or us to offer a better onboarding experience. + +### Prerequisites + +- **`DATABASE_URL`** — A serverless Postgres database. This project uses Drizzle with the PostgreSQL dialect. + Sign up for Neon + + Or, if you prefer the CLI: `neonctl databases create --name contentport` ([Neon CLI docs](https://neon.com/docs/reference/cli-databases)) + +- **`NEXT_PUBLIC_POSTHOG_KEY`** — A PostHog project API key for analytics. + Sign up for PostHog + +### Follow along + +1. **Download the source code.** Clone the repo locally: + ```bash + gh repo clone joschan21/contentport + # or via HTTPS + git clone https://github.com/joschan21/contentport.git + ``` +2. **Configure secrets.** Set environment variables: + ```bash + cp .env.example .env + ``` + Then fill in the keys obtained from [Prerequisites](#prerequisites) (at minimum `DATABASE_URL`). +3. **Install dependencies:** + ```bash + bun i + ``` +4. **Push the database schema:** + ```bash + bun db:push + ``` +5. **Run the development server:** + ```bash + bun dev + ``` + +--- + +## **Public Roadmap** (last updated: 29th Nov 2025) + +### **Features in Pipeline** -### **Priority 1** +#### **Priority 1** * Dark mode (requested by many users) * Responsive layout (requested by many users) @@ -32,7 +113,7 @@ --- -### **Priority 2** +#### **Priority 2** * Switch between different LLMs — personal wish (Jo) * Personalized example ideas (similar to the OpenAI Atlas Browser) — requested by many @@ -40,14 +121,14 @@ --- -### **Priority 3** +#### **Priority 3** * Viral tweet library (potentially useful feature) * Enable web browsing (potentially useful feature) --- -## **Bugs** +### **Bugs** * Timezone issues / “-1 days” calendar error * Creating transcripts from videos @@ -56,7 +137,7 @@ --- -## **Improvements** +### **Improvements** * Assistant style handling * Upgrade modal / paywall / email flow