Blindfold

Blindfold is a small web app built in Node.js that allows you to turn off/on retweets from the people you follow on Twitter. Because life is too short to keep ingesting negative crap all the time.

Getting started

These instructions will get you a copy of the project up and running on your local machine for development and testing purposes.

Prerequisites

What you’ll need to get started.

• Git
• NodeJS 16+
• npm or Yarn

Initial setup

1. Using Git, clone this repository to your local machine.
2. Run npm install or yarn install from inside the project's directory to install all dependencies.
3. Get your API Key and API Secret from https://developer.twitter.com
4. Run cp ./env.local.sample ./.env and adjust config variables.

Configuration

Blindfold has only a handful of options, but they are all required before the app can run, otherwise expect it to complain.

Development

If you want to tinker with this project, you can use Vue CLI to help you handle Hot Module Reloading (HMR).

First, launch the backend, powered by Express

$ yarn express
# or
$ npm run express

Second, launch Vue.js frontend

# launch dev server for the frontend UI
$ yarn serve
# or
$ npm run serve

Deploying

To deploy, you only need to make sure to clone the repo, install dependencies, then run yarn build and make sure to point your proxy to the ./build directory in order to serve the frontend properly.

Contributing

This is a hobby project that most likely has bugs, untested things, and can likely fall on its head when mistreated. Feel free to report any issues, feature requests, etc.

If you spot something you can fix yourself, fork the repo, commit your code on a feature branch and open a pull request.

I will happily review all contributions, especially those that help with establishing testing of the app.

Notice

This app was never meant to be yet another Twitter client of any kind, so don't expect me to add new features such as feeds, lists, etc.

---

© Matthew Morek