https://github.com/snazzah/slash-create-worker

slash-create with Cloudflare Workers template
https://github.com/snazzah/slash-create-worker

cloudflare cloudflare-workers discord discord-bot slash-create

Last synced: 3 months ago
JSON representation

slash-create with Cloudflare Workers template

• Host: GitHub
• URL: https://github.com/snazzah/slash-create-worker
• Owner: Snazzah
• Created: 2021-09-27T17:20:58.000Z (over 3 years ago)
• Default Branch: master
• Last Pushed: 2023-11-07T20:33:55.000Z (about 1 year ago)
• Last Synced: 2024-05-09T17:04:12.548Z (9 months ago)
• Topics: cloudflare, cloudflare-workers, discord, discord-bot, slash-create
• Language: TypeScript
• Homepage: https://slash-create.js.org
• Size: 329 KB
• Stars: 19
• Watchers: 2
• Forks: 19
• Open Issues: 0
• Metadata Files:
  • Readme: README.md

Awesome Lists containing this project

README

        
# /create with Cloudflare Workers

A [slash-create](https://npm.im/slash-create) template, using [Cloudflare Workers](https://workers.cloudflare.com).

[![Deploy to Cloudflare Workers](https://deploy.workers.cloudflare.com/button)](https://deploy.workers.cloudflare.com/?url=https://github.com/Snazzah/slash-create-worker)

## Getting Started

### Cloning the repo

You can either use degit to locally clone this repo without git, or [create a new repo from this template](https://github.com/Snazzah/slash-create-worker/generate) and clone that.

```sh

npx degit Snazzah/slash-create-worker

```

After that, make sure to install dependencies using npm or yarn:

```sh

npm install

# yarn

```

### Installing and setting up Wrangler

> Make sure to [sign up for a Cloudflare Workers account](https://dash.cloudflare.com/sign-up/workers) in a browser before continuing.

Install wrangler with npm or yarn:

```sh

npm install -D wrangler@latest

# yarn global add wrangler@latest

```

Read more about [installing wrangler](https://developers.cloudflare.com/workers/cli-wrangler/install-update).

Afterwards, run `wrangler login` to login to your Cloudflare account with OAuth:

```sh

wrangler login

```

### Filling in secrets

You can enter in environment secrets with `wrangler secret put`, here are the keys that are required to run this:

```sh

npx wrangler secret put DISCORD_APP_ID

npx wrangler secret put DISCORD_PUBLIC_KEY

npx wrangler secret put DISCORD_BOT_TOKEN

```

### Development

To run this locally, copy `.env.example` to `.dev.vars` and fill in the variables, then you can run `npm run dev` (or `yarn dev`) to start a local dev environment and use something like ngrok to tunnel it to a URL.

To sync commands in the development environment, copy `.env.example` to `development.env` and fill in the variables, then run `npm run sync:dev` (or `yarn sync:dev`).

> Note: When you create a command, make sure to include it in the array of commands in `./src/commands/index.ts`.

### Production

To sync to production, copy `.env.example` to `.env` and fill in the variables, then run `npm run sync`. To publish code to a worker, run `npm run deploy`.