Skip to content

Improve README describing how to run locally #6

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
murilooon wants to merge 1 commit into
base: master
Choose a base branch
from
Open

Improve README describing how to run locally #6

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
14 changes: 14 additions & 0 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -42,3 +42,17 @@ The bot will offer a default value for each parameter.
### Example POAP Event

![POAP-bot example](https://res.cloudinary.com/dbiqkiypz/image/upload/v1604800813/Screen_Shot_2020-11-07_at_23.00.04_z3xulj.png)

## Run locally

1. `npm install`
2. `npm install -g nodemon`
3. `sudo -i -u postgres`
4. `psql`
5. Run all queries on `db/schema.js` to create the tables
6. Create a bot [here](https://discord.com/developers/applications/817041487161196594/information) and get the token. You can follow [this tutorial](https://www.howtogeek.com/364225/how-to-make-your-own-discord-bot/)
7. Copy the bot Token and paste in the end of the `bot.js`, on `process.env.BOT_TOKEN`
8. `npm run start`
9. Paste the bot Client ID in this url: `https://discordapp.com/oauth2/authorize?client_id=CLIENTID&scope=bot`
10. Access the URL and let the bot join your server
11. Finished! Now have fun using it!