Skip to content

Latest commit

 

History

History
159 lines (92 loc) · 4.02 KB

README.md

File metadata and controls

159 lines (92 loc) · 4.02 KB
Raw

Threadr

Threadr is a small (#workinprogress) web application that helps users of micro-blogging platforms to write great threads and allows them to crosspost in one click their content to Bluesky, Mastodon and Twitter/X.

Threadr-v0.5.0

Core features

  • Write threads
    • Add, edit, remove messages
    • Add, describe, remove message images (up to 4 by message)
  • Save a thread
  • List all threads (by status, e.g. draft, scheduled, published)
  • Publish a thread
  • Schedule (and cancel) a thread publication
  • Configure platforms in a settings manager
    • display name
    • avatar
    • Bluesky activation and configuration
    • Mastodon activation and configuration
    • Twitter activation and configuration

Installation

For now, Threadr only works in localhost.

1/ Get the project sources

$ git clone git@github.com:jbuget/threadr-app.git && cd threadr-app

2/ Copy the .env.sample file into a new .env file

You previously must generate, get and report your access keys for Twitter/X (new developer project), Mastodon (new app) and Bluesky (your user credentials).

3/ Run the Docker compose service minio (required to upload media files into platforms)

$ docker compose up -d

4/ Configure your MinIO instance

MinIO console is accessible on localhost:9001. Credentials are defined in .envfile, cf. MINIO_ROOT_USER and MINIO_ROOT_PASSWORD. By default, values are "minio-admin" / "my-secured-password".

MinIO login screen

Create a bucket (ex: "threadr-app" in .env.sample).

Create a MinIO bucket

In the MinIO settings, configure MinIO region (ex: "eu-fr-1" in .env.sample).

Region Configuration in MinIO

⚠️ It is recommanded to declare a custom policy with dedicacted path in readonly acces for anonymous visitors

Add anonymous access rule

Anonymous access rule result

5/ Run Threadr locally

$ npm install
$ npm run dev -- -o

6/ 🚀 Enjoy Threadr at localhost:3000!

7/ (bonus) You can follow your scheduled threads in BullMQ console

Run the following command :

$ npx bullmq-dashboard-runnable thread-schedules -P 3001

Then access localhost:3001.

BullMQ console

Configuration

All configuration option are set in the .env file.

Uploading media files

MINIO_ENDPOINT: URL

The endpoint URL of MinIO/S3 server on which temporarily upload media files.

MINIO_REGION: string

The region of the MinIO/S3 server.

MINIO_BUCKET_NAME: string

The bucket where the media files will be upload before being sent to platforms.

MINIO_MEDIA_PATH: string

The folder path inside the bucket.

MINIO_ACCESS_KEY: string

The MinIO access key to access the bucket in order to deposit media files.

MINIO_SECRET_KEY: string

The MinIO access secret key to access the bucket in order to deposit media files.

MINIO_ROOT_USER: string

The MinIO administration account username (used for docker-compose MinIO container).

MINIO_ROOT_PASSWORD: string

The MinIO administration account password (used for docker-compose MinIO container).

Persisting data

DATABASE_URL: (PostgreSQL) URL

The PostgreSQL database URL

POSTGRES_USER: string

The PostgreSQL administration account username (used for docker-compose postgres container).

POSTGRES_PASSWORD: string

The PostgreSQL administration account password (used for docker-compose postgres container).

POSTGRES_DB: string

The PostgreSQL database.

Scheduling thread publication

REDIS_URL: (Redis) URL

The Redis database URL, used by BullMQ.