/Roblox-Catalog-Notifier

A Node.js server that posts new Roblox UGC avatar items to Twitter.

Primary LanguageJavaScriptGNU General Public License v3.0GPL-3.0

Roblox Catalog Notifier

Roblox Catalog Notifier

Warning

This repository is no longer being maintained and is now archived.

A Node.js server that posts new Roblox items to Twitter. You can see it in action on @CatalogUpdates.

Fetches the latest items using the Roblox Marketplace API then posts new items to Twitter using the Twitter API.

Prerequisites

Setup

Install dependencies

To install all of this project's dependencies, first make sure you have NPM installed and then run the below command to install dependencies.

npm install

Add environment variables

We need to setup environment variables so we know how to access your App and tweet using it.

You can find your credentials in the App inside of your Project in the dashboard of the developer portal.

Once you found then, create a .env in the root of your project, typically the same directory as index.js. It should look like the below but with different keys.

CONSUMER_KEY=QAktM6W6DF6F7XXXXXX
CONSUMER_SECRET=AJX560A2Omgwyjr6Mml2esedujnZLHXXXXXX
ACCESS_TOKEN=1995XXXXX-0NGqVhk3s96IX6SgT3H2bbjOPjcyQXXXXXXX
ACCESS_TOKEN_SECRET=rHVuh7dgDuJCOGeoe4tndtjKwWiDjBZHLaZXXXXXX

Usage

Starting

Once you have finished setting up your project, you can use NPM to start the server.

npm start

Testing

If you plan to push code then you should be testing it. Run the below command to run jest tests using npm.

npm test

License

Licensed under the GNU General Public License v3.0. See LICENSE for details.