search

Learn-Build-Teach / learn-build-teach-discord-bot

53 stars 17 forks source link

Add "How to Run" Section to ReadMe #13

Closed jamesqquick closed 3 years ago

jamesqquick commented 3 years ago

This Readme is very minimal and should be updated. We should add a "How to Run" section that includes what environment variables are needed to run the project and which command can be used to run.

Here's an example of the environment variables.

AIRTABLE_API_KEY=
AIRTABLE_SHARE_TABLE_NAME=
AIRTABLE_USER_TABLE_NAME=
AIRTABLE_BASE_ID=
DISCORD_BOT_TOKEN=
DISCORD_GUILD_ID=

TWITTER_CONSUMER_KEY=
TWITTER_CONSUMER_SECRET=
TWITTER_ACCESS_TOKEN_KEY=
TWITTER_ACCESS_TOKEN_SECRET=

SEND_TWEETS=
kaf-lamed-beyt commented 3 years ago

Hi @jamesqquick I'd love to work on this.

I have a question...

The environment variables that you listed above. They are API keys that anyone must have before they can test this project, right?

jamesqquick commented 3 years ago

Hey @Caleb335 yes that is correct. We should probably include instructions on how to setup bot credentials as well as Airtable and Twitter credentials. Just links to an article or video would be good

kaf-lamed-beyt commented 3 years ago

Awesome!

I'd make my findings. Thank you for assigning this to me.

kaf-lamed-beyt commented 3 years ago

Hi @jamesqquick,

I'm reaching out to let you know that I'm still making my findings. Once I'm done, I'll send in my PR.

Thank you for understanding

kaf-lamed-beyt commented 3 years ago

Hi @jamesqquick, kindly unassign me from this issue. I'm currently choked up with other things, and I don't want a situation where I won't be able to deliver this task.

I'm sorry for the delay in realizing this sooner.

max-programming commented 3 years ago

@jamesqquick I will be honoured to be assigned this one 🙂

jamesqquick commented 3 years ago

@Caleb335 no worries. It happens! @max-programming assigning you now!