diff --git a/.env.example b/.env.example new file mode 100644 index 0000000..14ebafd --- /dev/null +++ b/.env.example @@ -0,0 +1,4 @@ +SLACK_APP_TOKEN= +SLACK_BOT_TOKEN= +FLIGHTAWARE= +DATABASE_URL=file:./db.sqlite \ No newline at end of file diff --git a/README.md b/README.md index 58f894f..7d6a416 100644 --- a/README.md +++ b/README.md @@ -1,15 +1,19 @@ -# slackbot-workshop +# flight-slack -To install dependencies: +this is a slack bot that sends flight information and updates to a selected slack channel. -```bash -bun install -``` +it's currently wip and a submission for [Converge](https://converge.hackclub.com/). -To run: +## Stack +- [Bun](https://bun.sh/) +- [FlightAware AeroAPI](https://flightaware.com/aeroapi/) +- [Slack Bolt](https://slack.dev/bolt-js/) +- [TypeScript](https://www.typescriptlang.org/) +- [Prisma](https://www.prisma.io/) -```bash -bun run index.ts -``` - -This project was created using `bun init` in bun v1.2.15. [Bun](https://bun.sh) is a fast all-in-one JavaScript runtime. +## Development setup +1. Clone the repository +2. Fill out .env values +3. `bun install` +4. `bunx prisma migrate dev` +5. `bun dev` \ No newline at end of file