/microvot

Spreading the word about Microverse

Primary LanguageJavaScriptMIT LicenseMIT


Logo

MICROVOT

Gospel CodeFactor
Spreading the word about @microverseinc!
Follow · Report Bug · Request Feature

Table of Contents

About The Project

Microvot is a simple bot that periodically search Twiter for tweets mentioning @microverseinc, and retweets them in a batch.

It uses GitHub Actions on a scheduled interval. You can take a look at the action here.

The Twitter API allows to search using the since_id parameter, so we stored the max_id of the last search we have seen on a gist, and on the next search we use that max_id as the next since_id. That way we get only the new tweets made after each search.

Built With

Getting Started

To get a local copy up and running clone the repository and move into the directory:

git clone https://github.com/mauriciorobayo/microvot.git
cd microvot

Prerequisites

Go to Twitter Developer to create a new app and get the keys and tokens.

Once you get the keys and tokens, copy the .env.sample file to a .env file in the root of the project, and copy-paste your credentials.

You will also need a GitHub personal access token with gist scope to copy-paste into the .env file.

Installation

To install the dependencies of the project run npm install.

You will need to generate an initial empty gist, once you have it, you'll need to update the info to the gist on src/memo.js

Usage

You can clone this project and use at as a template to create your own bot that periodically does a search on Twitter and retweets whatever you want.

Roadmap

See the open issues for a list of proposed features (and known issues).

Contributing

Contributions are what make the open source community such an amazing place to be learn, inspire, and create. Any contributions you make are greatly appreciated.

  1. Fork the Project
  2. Create your Feature Branch (git checkout -b feature/AmazingFeature)
  3. Commit your Changes (git commit -m 'Add some AmazingFeature')
  4. Push to the Branch (git push origin feature/AmazingFeature)
  5. Open a Pull Request

License

Distributed under the MIT License.

Contact

Mauricio Robayo - @MauricioRobayo.

Project Link: https://github.com/MauricioRobayo/microvot

Acknowledgements