olanetsoft / web3terms Goto Github PK

View Code? Open in Web Editor NEW

96.0 4.0 52.0 559 KB

A bot explaining and simplifying web3 terms to everyone

Home Page: https://twitter.com/web3terms

License: MIT License

JavaScript 99.29% Shell 0.71%

nodejs twitter-bot opensource javascript twitter twitter-api blockchain ethereum resources hacktoberfest

web3terms's Introduction

web3terms

A Twitter bot explaining and simplifying web3 terms to everyone!

🏆 Features

Web3 terms explanation ✅
Daily Web3 terms tweet ✅
Acknowledgement tweet ✅
Test Coverage ✅

Endpoint https://web3terms.onrender.com/terms to retrieve all terms ✅

Response:

    {
        "previousPage": "xx",
        "nextPage": "xx",
        "total": xxx,
        "totalPages": xxx,
        "items": [
            {
                "term": "abi",
                "meaning": "ABI is the standard way to interact with contracts in the Ethereum ecosystem, both from outside the blockchain and for contract-to-contract interaction."
            },
            
            //...
        ]
    }

To filter, pass the query params page and/or limit.

🛠 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

yarn

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

🥂 After making a change

Sort the file

yarn run sort

Run a test to check all definition length

yarn test

Create a new branch

git checkout -b <Your-branch-name>

Add changes

git add .

Add a commit message

git commit -m "<your message>"

Push your changes

git push --set-upstream origin <branch-name>

Create a Pull Request
Congratulations 🙌🏼

🔀 Connecting to Twitter

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.

Now go here and log in as the Twitter account for your bot:
Fill up the form and submit.
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.

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

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

Note to Contributors

All web3 terms in the data/terms.json directory should be in lowercase.
Look to ensure that newly added terms aren't already available to avoid repetition of terms and keywords.

🫂 Credits

Twit Library
Nishant Srivastava
Ugwu Stanley the creator of Decode Abbreviation

Thanks to all Contributors 💪

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

Thanks to all Stargazers ⭐️

web3terms's People

Contributors

Stargazers

Watchers

Forkers

makacoder kohasummons mm-s doprax1 shosenwales awojobigodfrey resourcefulmind alaomichael pqcsig mide001 francescoxx devmukhtarr oneknucklehead ahmedsilat44 khairallaha amethystcodes ivcandela rishav-12 0xcryptochica asaniyan qudusayo nametsego 22388o himanshu-malviya15 anant-c oyedeletemitope firascodes ayanwumi101 nully0x nwizu033 2brownc bishopaudu xeno097 ssghost afpedreros choubari adamsgeeky marsifeanyi moty12 savvyviv zenunicorn frankiefab100 omahs josh4324 yhuakim phenzic adedoyin-emmanuel nobleosinachi chrisawoke steelyycoon

web3terms's Issues

Docs: Add contributing.md file

Feat: Add More relevant web3 terms

Add more web3 terms
The meaning length must not exceed 280 characters.

Fix: Update all `terms` to lower case

#52

Feat: Add a yarn command to remove or comment repeated terms

I saw that there are many repeated terms with different definitions.

We can add a yarn command to remove or comment the repeated terms in terms.json file

Feat: Add More Web3 Terminologies

Add more web3 terms here
Follow the format in the file
The meaning length must not exceed 280 characters.

Handle Case Sensitive Keywords

ISSUE

Currently, the keyword that is present inside the terms.json is matched exactly with the provided input KW from the tweet which shouldn't be matched exactly. So, it's better to handle the case of the keyword.

SOLUTION

Converting the input KW to lowercase and comparing the KW (in lower case) present in terms.json should solve the issue.

Fix: Update/Summarise web3 term meaning not more than 280 character including space.

This update is significant because Twitter API won't respond if the meaning length exceeds 280 characters.

Add an endpoint to return all the web3 terms

A user should be able to pull the web3 terms and definitions using a GET request to use it in other apps

For example, a quiz game or card game for explaining the terms

feat: Add tests to verify web3 terms data format

Context

Issue 35 specifies that the term's meaning should be 280 characters long or less and the term should be lowercase but currently, nothing enforces this rule or warns about it, which means that the only way to notice this is either during a code review or if the Twitter API does not respond as explained here 41

Extra

A test to verify that every term is unique could be added

Feat: Add Husky and define git hooks to sort and test automatically when a commit is made

I saw in the Readme that after making a change we need to :

Sort the file: yarn run sort
Run a test to check all definition length: yarn test

Instead of manually doing that by each contributor, we can install Husky and define a pre commit hook to run these whenever we want to commit our changes.

I would like to work on this issue if possible.

Fix: Format ReadMe

Add required information where necessary
Add styles or formats to make the ReadMe better

Docs: Add a short explanation of conventional commits in the contributing.md file

I saw in the commit history that you're following the conventional commits, which may not be familiar to new contributors.

I would like to add a short explanation with practical examples in the contributing.md file to help new contributors write a better subject line in their commits before contributing.

I can work on this issue.

Refactor: Remove duplicated web3 terms

I noticed some web3 terms were repeated.
Eliminating the first instance should fix this.

See Screenshot:

L2

node

gas fees

In the case of sha256 and sha-256. This could be a variance.

Fix: Fix all the terms without tag

Fix all the Web3 terms in the terms.json without a tag. e.g. we have some in this format is a .... or This is a, change it to contain the terms like Bitcoin is a ...

Error: 404 Bad Streaming Request

After setting up all the Twitter Secret Keys and starting the run command yarn run dev

I noticed the following error message (Bad request Stream)

I'm guessing it's from the Twit framework and the updated twitter API endpoint for filtered streaming. I tried logging the streaming request from the node_module, like in the image above but couldn't find the requested link
I also tried updating the streaming endpoints to twitter v2 from node_module... (locally), still logging the same error.