Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/pubkeyapp/pubkey-bot
PubKey Bot is a customizable, secure open-source Discord verification bot. Based on Discord Linked Roles. Solana Hyperdrive Hackathon first price 🥇
https://github.com/pubkeyapp/pubkey-bot
Last synced: 11 days ago
JSON representation
PubKey Bot is a customizable, secure open-source Discord verification bot. Based on Discord Linked Roles. Solana Hyperdrive Hackathon first price 🥇
- Host: GitHub
- URL: https://github.com/pubkeyapp/pubkey-bot
- Owner: pubkeyapp
- License: mit
- Created: 2023-09-12T19:00:29.000Z (about 1 year ago)
- Default Branch: main
- Last Pushed: 2023-10-21T18:11:56.000Z (about 1 year ago)
- Last Synced: 2024-08-01T08:11:01.084Z (3 months ago)
- Language: TypeScript
- Homepage:
- Size: 1.26 MB
- Stars: 5
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
- awesome - pubkeyapp/pubkey-bot - PubKey Bot is a customizable, secure open-source Discord verification bot. Based on Discord Linked Roles. Solana Hyperdrive Hackathon first price 🥇 (TypeScript)
README
# PubKey Bot
## Getting Started
### Prerequisites
- Node v18 or higher
- Yarn
- Docker
### Installation
Clone the repo and install dependencies:
```bash
git clone [email protected]:pubkeyapp/pubkey-bot.git
cd pubkey-bot
yarn
```
### Automatic setup
You can run the automatic setup script to create the `.env` file, test the setup and push the database schema.
```bash
yarn setup
```
### Environment variables
Copy the `.env.example` file to `.env` and fill in the missing values.
```bash
cp .env.example .env
```
### Starting the services
You will need to start the database before starting the backend.
```bash
yarn dev:services
```
### Pushing the database schema
If you start from scratch, you will need to push the database schema to the database.
```bash
yarn prisma db push
```
Also, after each change to the schema in `prisma/schema.prisma`, you will need to run the above command again.
### Starting the API
```bash
yarn dev:api
```
### Starting the web ui
```bash
yarn dev:web
```
### Starting the SDK generator
```bash
yarn dev:sdk
```