DAO-pairbot

DAO-pairbot copied to clipboard

About The Project

The idea behind the bot is to help people collaborate, learn and in the end make new friends. Especially now in the beginning where everything feels chaotic and you don’t know where to begin. The idea is that you can use the bot to see what other people are busy building and if they are available you can join and help build something awesome together.

Built With

• TypeScript
• Discord.js
• Supabase

Getting Started

Prerequisites

• npm
• Node.js (16.13.0)
• Supabase Account

Installation

1. Clone the repo

git clone https://github.com/Developer-DAO/DAO-pairbot.git

2. Change directory and install NPM packages

cd DAO-pairbot && npm install

3. Create a new Supabase project. We will need the Superbase Url and Anon Key to put in our .env file later.
4. Copy the snippet from SQL-snippets and paste in the SQL Editor on Supabase and click run.
5. Copy .env.example to .env We will fill it in with your details from Supabase details from before and your Discord details in the next few steps.
6. In the discord desktop app, create your own discord server to use for testing.
7. Enable Developer mode in your Discord desktop app by going to User Settings > Advanced > Enabled 'Developer Mode'
8. Right click on the server name and click Copy ID. This is the Guild Id in .env
9. Right click on the 'general' channel and click Copy ID. This is the Discord channel id in .env
10. Finally we need to create a Discord app in the Discord developer area. Call it pairapp or something.
11. Once you have created the app, get the Application Id. This is on the General information tab and can be used as Client ID in .env.
12. Next, click the Bot tab on the left and add a new bot. In this tab there is a Copy and Regenerate button with a link above them to reveal a bot. Click that link and use the revealed token as DISCORD_TOKEN in .env
13. Lastly click the OAuth tab and then the sub tab for URL Generator. Select 'bot' and 'application.commands' in the top perms and then a new box will appear, select 'Administrator' in the bottom box. Copy the url into your web browser and then navigate to it, selecting your test Discord server when prompted. This will add the bot to your test server.

Usage

These are the current commands the bot supports:

• /add - Add yourself to the pairing database
• /edit - Edit your profile on the pairing database
• /edit others - Edit your profile's twitter/github/timezone on the pairing database
• /edit experience - Edit your profile experience level on the pairing database
• /edit skills - Edit your profile skills on the pairing database
• /edit desired_skills - Edit your profile desired skills on the pairing database
• /available - Set yourself as available
• /unavailable - Set yourself as unavailable
• /developers - List all developers in the paring database
• /invite - Invite an available developer to pair up with
• /invites - List all the invites people sent you
• /remove - Remove yourself from the pairing database

Roadmap

• [ ] Finish basic features
• [ ] Add Projects
• [ ] Add Website Interface
• [ ] Add User analytics to Website
• [ ] Add Project analytics to Website

Contributing

Contributors ✨

Thanks goes to these wonderful people (emoji key):

Martin Buxmann 💻

Calvaz 💻 📖

Jim Cummins 📖

cachemon.eth 💻

This project follows the all-contributors specification. Contributions of any kind welcome!

License

Contact

Acknowledgments