Skip to content

A bot explaining and simplifying web3 terms to everyone

License

Notifications You must be signed in to change notification settings

FrancescoXX/web3terms

 
 

Repository files navigation

web3terms

GitHub issues GitHub forks GitHub stars GitHub watchers Twitter Follow

A Twitter bot explaining and simplifying web3 terms to everyone!

Screenshot 2022-04-07 at 22 58 40

🏆 Features

  • Web3 terms explanation ✅
  • Daily Web3 terms tweet ✅
  • Acknowledgement tweet ✅

🛠 Installation

  • Install Node.js on your PC
  • Start by making a fork of the repository. Click on the "Fork" symbol at the top right corner
  • Clone this repo
git clone https://github.com/Olanetsoft/web3terms.git
  • Run
yarn

It will install Twit, the library that lets us talk to Twitter.

🥂 After making a change

  1. Create a new branch
git checkout -b Your-branch-ame
  1. Add changes
git add .
  1. Add a commit message
git commit -m"<your message>"
  1. Push your changes
git push
  1. Create a Pull Request

  2. Congratulations 🙌🏼

🔀 Connecting to Twitter

  1. Register a Twitter account and also get its "app info".

Twitter doesn't allow you to register multiple twitter accounts on the same email address. I recommend you create a brand new email address (perhaps using Gmail) for the Twitter account. Once you register the account to that email address, wait for the confirmation email.

  1. Now go here and log in as the Twitter account for your bot:
  2. Fill up the form and submit.
  3. Next once the submission completes you will be taken to a page which has the
  • "Settings" tab : Update details here
  • "Permissons" tab : Enable Read and Write
  • "Key and Access Token" tab : Click on Generate access token.
  1. Create a .env file and fill in the generated tokens in the "Key and Access Token" tab. It should look like this: PORT=xxxx NODE_ENV=development

DEV_BASE_URL=http://localhost:$PORT PROD_BASE_URL=http://localhost:$PORT

TWITTER_CONSUMER_KEY=xxxx TWITTER_CONSUMER_SECRET=xxxx

TWITTER_ACCESS_TOKEN=xxxx TWITTER_ACCESS_TOKEN_SECRET=xxxx

  1. Type the following in the command line in your project directory to start the project
yarn dev

You should have something similar to what is shown below on your terminal.

[LOGGING] info: "Connected!"
[LOGGING] info: "Server running on port xxxx"

👨‍👩‍👦 Community

Don't forget to follow Web3terms on twitter

🧑‍💻 Contributing

  • Contributions make the open source community such an amazing place to learn, inspire, and create.
  • Any contributions you make are greatly appreciated.
  • Check out our contribution guidelines for more information.
  • Star - If you like it
  • Fork - If you like to build your own version
  • File an issue - If you found a bug
  • Send a pull request - If you want to contribute

Whats Next

You might want to push this app to a running server, here is a curated list you can checkout..

Do not misuse the twitter api to spam or burden the server load for twitter api , as twitter follows a strict rule of closing down accounts that do that. Please read here for the rules

🫂 Credits

Thanks to all Contributors 💪

Thanks a lot for spending your time helping Web3Terms Bot grow. Happy Hacking 🍻

Contributors

About

A bot explaining and simplifying web3 terms to everyone

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published

Languages

  • JavaScript 100.0%