Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/jbuget/threadr-app

A micro-blogging threads editor (compatible with Bluesky, Mastodon and Twitter)
https://github.com/jbuget/threadr-app

hacktoberfest

Last synced: about 2 months ago
JSON representation

A micro-blogging threads editor (compatible with Bluesky, Mastodon and Twitter)

Host: GitHub
URL: https://github.com/jbuget/threadr-app
Owner: jbuget
Created: 2023-08-28T17:10:06.000Z (over 1 year ago)
Default Branch: main
Last Pushed: 2024-02-14T17:40:08.000Z (11 months ago)
Last Synced: 2024-02-15T00:36:39.065Z (11 months ago)
Topics: hacktoberfest
Language: Vue
Homepage:
Size: 12.1 MB
Stars: 20
Watchers: 2
Forks: 1
Open Issues: 4
Metadata Files:
- Readme: README.md

Awesome Lists containing this project

README

# 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](./docs/threadr-v0.5.0.png)

## 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

```shell
$ git clone [email protected]: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)

```shell
$ docker compose up -d
```

**4/** Configure your MinIO instance

MinIO console is accessible on [localhost:9001](http://localhost:9001). Credentials are defined in `.env`file, cf. `MINIO_ROOT_USER` and `MINIO_ROOT_PASSWORD`. By default, values are "minio-admin" / "my-secured-password".

![MinIO login screen](./docs/minio_login.png)

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

![Create a MinIO bucket](./docs/minio_create_bucket.png)

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

![Region Configuration in MinIO](./docs/minio_configure_region.png)

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

![Add anonymous access rule](./docs/minio_configure_anonymous_access_rule.png)

![Anonymous access rule result](./docs/minio_bucket_access_policy.png)

**5/** Run Threadr locally

```shell
$ npm install
$ npm run dev -- -o
```

**6/** 🚀 Enjoy Threadr at [localhost:3000](http://localhost:3000)!

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

Run the following command :

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

Then access [localhost:3001](http://localhost:3001).

![BullMQ console](./docs/bullmq_console.png)

## 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.