README.md

Bookmark Bot (TS)

This is a Twitter Bookmark Bot (in TypeScript)

Prerequisites

• Install Node and NPM
• Install Yarn
• Install TypeScript
• Optional: Install Node Version Manager (this project uses Node version 14.1.0)

Initial Setup

1. Install dependencies via yarn install

2. Create a .env file at the root and add the following credentials:

• TWITTER_API_KEY (Get Twitter credentials here)
• TWITTER_API_SECRET
• TWITTER_ACC_TOKEN
• TWITTER_ACC_TOKEN_SECRET
• THEDOGAPI_API_KEY (Get 'The Dog API' credentials here)
• UNSPLASH_API_ACC_KEY (Get Unsplash credentials here)
• UNSPLASH_API_SECRET_KEY

2. Run the app using yarn dev

How to Run Tests

• Pending...

Dev Notes

1. Squash your PRs often (and delete your branches once merged)

// format
feat(ure): feature name...
fix: fix name...

2. Remember to update the README when necessary