https://github.com/12joan/twitter-client

A temporary Twitter client for fetching recent tweets for use while Twitter is closed to guest users
https://github.com/12joan/twitter-client

Last synced: 2 months ago
JSON representation

A temporary Twitter client for fetching recent tweets for use while Twitter is closed to guest users

• Host: GitHub
• URL: https://github.com/12joan/twitter-client
• Owner: 12joan
• License: unlicense
• Created: 2023-07-04T10:28:49.000Z (over 1 year ago)
• Default Branch: main
• Last Pushed: 2024-04-08T06:35:57.000Z (9 months ago)
• Last Synced: 2024-04-08T07:40:06.039Z (9 months ago)
• Language: TypeScript
• Size: 366 KB
• Stars: 26
• Watchers: 3
• Forks: 5
• Open Issues: 7
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# 12joan/twitter-client

A temporary Twitter client for fetching recent tweets for use while Twitter is closed to guest users.

Based on [this script](https://github.com/zedeus/nitter/issues/919#issuecomment-1619263153) by [polkaulfield](https://github.com/polkaulfield).

**[🚀 Publish new version](https://github.com/12joan/twitter-client/compare/deployment...main?expand=1&title=Deploy%20production&body=Merging%20this%20PR%20will%20trigger%20a%20deployment%20to%20production)** - Create a PR that will push the contents of `main` to the Docker registry when merged

## Deployment with Docker

Create a file `docker-compose.yml` with the following content:

```yml

version: '3'

services:

  web:

    image: ghcr.io/12joan/twitter-client:production

    environment:

      REDIS_URL: redis://redis:6379

      HOST: '0.0.0.0'

    ports:

      - 3000:3000

    depends_on:

      - redis

  redis:

    image: redis:latest

```

Start using `docker-compose up -d` and access at http://localhost:3000/.

The `production` tag is updated when the `deployment` branch receives new commits. You can also try out the lastest version on `main` using the `alpha` tag. Anyone can update the `deployment` branch by clicking the **Publish new version** link at the top of this README.

## Deployment without Docker

- [Red Hat Enterprise Linux](https://github.com/12joan/twitter-client/wiki/Install:NoDocker:Rocky-Linux-8.6)

## Usage

### Raw JSON data

You can fetch recent Tweets as JSON from `http://localhost:3000/:username`.

Example: `http://localhost:3000/amnesty`

### RSS feed

To format the results as an RSS feed, use `http://localhost:3000/:username/rss`.

Optionally, specify a preset "flavour" of RSS using `http://localhost:3000/:username/rss?flavour=slack`. Supported flavours:

- `default`

  - Title: Tweet text

  - Description: Tweet text + media URLs as image tags

- `slack`

  - Title: Tweet URL

  - Description: Tweet text + media URLs as links

## Running locally

To start the server,

```

$ yarn install # See https://github.com/12joan/twitter-client/issues/6

$ docker-compose up --build

```

To check types on file change,

```

$ yarn typecheck:watch

```

To fix code formatting,

```

$ yarn lint --fix

```