search

gbowne1 / TwitchBot

A MERN full stack TwitchBot
MIT License
7 stars 10 forks source link

[TODO] create documentation for server database backend #67

Open gbowne1 opened 8 months ago

gbowne1 commented 8 months ago

To reduce the time to live workload for the streamer to get this bot connected and authentication and auth to Twitch.tv chat add some documentation on

loki4514 commented 8 months ago

hello what documentation i should update, can you tell me more about it.

gbowne1 commented 8 months ago

@loki4514

There is no documentation created yet except for testing.

We will be putting the documentation on the Wiki tab in markdown format.

This TwitchBot is incomplete.

Basic documentation still needs to be written as mentioned in this TODO issue

If you would like to work on this let us know

loki4514 commented 8 months ago

sure, i'm interested to work on.

gbowne1 commented 8 months ago

A lot of the basic information is in the README.md but for the sake of completeness and ease of use it will need to be added to the Wiki

If you need help myself and @jarmentor are the current maintainers.

You can clone / fork the Wiki directly from the Wiki tab on Github

https://github.com/gbowne1/TwitchBot/wiki

loki4514 commented 8 months ago

sure i will.

loki4514 commented 8 months ago

https://github.com/loki4514/TwitchBot/wiki i'm complete begineer, am i in the right track?

gbowne1 commented 8 months ago

Yes that is a good start @loki4514

loki4514 commented 8 months ago

@gbowne1 wiki link here is updated wiki go through, tell me changes has to made. Trying to run on local machine mongo uri db it can any db right? i have test db atlas uri. i have my twich username and passowrd, what's the channel ?

gbowne1 commented 8 months ago

@loki4514

I think channel name can be any channel name youre intending to connect the bot to.

I would refer to the TMI.js and Twitch API docs for that.

I believe it requires Oauth2 to be Implemented and you have to register the app and stuff Im not certain about (yet).

loki4514 commented 8 months ago

is wiki content all ok need to be added anything to it ?

gbowne1 commented 8 months ago

@loki4514

Seems to be fine. We can add to it as needed.

It does need instructions on using it with mongodb cli using mongod server, mongosh shell. As well as instructions on using it with mongodb atlas and or compass.

I would say to name the database twitchbot because thats what I did

loki4514 commented 8 months ago

sure, i attached the youtube video how to setup a atlas, if want me to write steps, i will be writing it no worries.

gbowne1 commented 8 months ago

@loki4514

Actual written steps might help people that don't want to sit through a video. But would be helpful in cases to have both video and text to refer to.. and maybe links to mongo documentation

loki4514 commented 8 months ago

sure, i will work on that, no problem.

loki4514 commented 8 months ago

@gbowne1 here's wiki link thoughts on mongo db setup documentation?

gbowne1 commented 8 months ago

That looks pretty good other than account is misspelled accound.

loki4514 commented 8 months ago

i will look into typos, ok apart this what else needs to added?

gbowne1 commented 8 months ago

It also seems to be posting to your own local clone/fork (https://github.com/loki4514/TwitchBot.wiki.git) of the repo which is ok if you intend to actually use the bot.

But you should really git clone https://github.com/gbowne1/TwitchBot.wiki.git and make the changes there instead then commit and push to there. (I've not found a way to PR changes to the wiki)

Edit: maybe it requires agit fork https://github.com/gbowne1/TwitchBot.wiki.git in order to PR the wiki?

I would also add instructions in a separate section for using mongod (the mongodb cli server) and mongosh (cli shell/client) which can be installed from apt (on linux). to start mongod just go into the terminal and type mongod and it will start. same with mongosh. once they are installed. start the mongod first then mongosh. then in mongosh type use twitchbot.

It seems your instructions for Atlas are fine.

loki4514 commented 8 months ago

https://github.com/loki4514/TwitchBot/wiki here is updated on some how i cloned the it, but can't create a pr request.

gbowne1 commented 8 months ago

@loki4514

I am not sure you can PR. I believe that the wiki is direct commit and push only. Why that is I don't know.

Hard to say. I don't have any experience with it.

Either way youre only modifying your copy of the Wiki.

You will have to clone the original Wiki and copy all the work you did to yours over to my TwitchBot repo. If you can do that let me know.

Your changes so far look pretty good