mirror of
https://github.com/KevinMidboe/waka-box.git
synced 2025-10-29 09:50:22 +00:00
Update setup docs
This commit is contained in:
31
README.md
31
README.md
@@ -8,19 +8,26 @@
|
|||||||
|
|
||||||
## Setup
|
## Setup
|
||||||
|
|
||||||
Create a GitHub Gist and create a token with the `gist` scope.
|
### Prep work
|
||||||
|
|
||||||
Register a Twitter app and create a `.env` file:
|
1. Create a new public GitHub Gist (https://gist.github.com/)
|
||||||
|
1. Create a token with the `gist` scope and copy it. (https://github.com/settings/tokens/new)
|
||||||
|
1. Create a new Twitter app (https://developer.twitter.com/en/apps/create)
|
||||||
|
1. On the App page for your newly created app, generate an "Access token & access token secret" and copy all keys and tokens.
|
||||||
|
|
||||||
```
|
### Project setup
|
||||||
GIST_ID=
|
|
||||||
GITHUB_TOKEN=
|
|
||||||
|
|
||||||
TWITTER_USER=
|
1. Fork this repo
|
||||||
TWITTER_CONSUMER_KEY=
|
1. Log into CircleCI with your GitHub (https://circleci.com/vcs-authorize/)
|
||||||
TWITTER_CONSUMER_SECRET=
|
1. Click on "Add Projects" on the sidebar
|
||||||
TWITTER_ACCESS_TOKEN_KEY=
|
1. Set up a project with the newly created fork
|
||||||
TWITTER_ACCESS_TOKEN_SECRET=
|
1. Go to Project Settings > Environment Variables
|
||||||
```
|
1. Add the following environment variables:
|
||||||
|
|
||||||
Adjust poll rate in `.circleci/config.yml`.
|
- **GIST_ID:** The ID portion from your gist url <code>https://gist.github.com/matchai/<b>6d5f84419863089a167387da62dd7081</b></code>.
|
||||||
|
- **GITHUB_TOKEN:** The GitHub token generated above.
|
||||||
|
- **TWITTER_USER:** The user handle of the twitter account.
|
||||||
|
- **TWITTER_CONSUMER_KEY:** Your Twitter consumer API key.
|
||||||
|
- **TWITTER_CONSUMER_SECRET:** Your Twitter consumer secret.
|
||||||
|
- **TWITTER_ACCESS_TOKEN_KEY:** Your Twitter access token key.
|
||||||
|
- **TWITTER_ACCESS_TOKEN_SECRET:** Your Twitter access token secret.
|
||||||
|
|||||||
Reference in New Issue
Block a user