Skip to content

Latest commit

 

History

History
56 lines (37 loc) · 955 Bytes

README.md

File metadata and controls

56 lines (37 loc) · 955 Bytes

BirdXplorer

Description

BirdXplorer is software that helps users explore community notes data on X (formerly known as Twitter).

Example Usecase

See example

Development

Requirements

Installation

pip install -e ".[dev]"

Environment Vars

cp .env.example .env
key value
BX_STORAGE_SETTINGS__PASSWORD birdxplorer

Testing

To run basic unit tests and some integration tests, simply run the following:

tox

For the data model testing, you need to download community notes data and store some directory (say data/20230924) and run the following:

BX_DATA_DIR=data/20230924 tox

Run Server

$ pwd
$ your_dir/BirdXplorer
$ docker-compose up -d