The source code for the Wikimedia Emoji Bot lives here
- Clone project:
git clone https://github.com/harshcrop/wikiemojibot
- Install Need Package Manager/Management (NPM) on Mac OS X:
brew install npm
Will add for other systems later here.
- Install dependencies for the project:
npm install
- Copy the example
.env
file:
cp .env.example .env
- Get credentials for your bot and complete the
.env
-
When logged-in on the Twitter's developer site, check the link on the top menu
My apps
(and it will take you to this site: https://apps.twitter.com/) or go straight away to type: https://apps.twitter.com/ on your browser. -
On the top-right, there is a button saying
Create New App
, click on it and follow the steps to fill in the form fields. -
Click the
Create your Twitter Application
button when you finish the immediate above step. -
Once the application is created, under the
Details
section, you will find the credentials to fill into your.env
file and additionally, under theKeys and Access tokens
, you will find all the keys and access tokens needed in the.env
file. -
When all these configs are done, your app can then connect to Twitter successfully and perform its various functions.
npm run status
npm run reply
npm test
Emoji additions, bug reports, fixes, and new features are welcomed. If you'd like to contribute code, please:
-
Fork the project
-
Start a branch named for your new feature or bug
-
Create a Pull Request
This project is originally built on the NYPL Emoji Bot project. Initial credits go to: Lauren Lampasone and other contributors for building the NYPL-Emoji-Bot.Readme file inspire by d3r1ck.