mirror of
https://github.com/SrIzan10/flight-slack.git
synced 2026-06-06 00:56:52 +00:00
docs: add readme
This commit is contained in:
4
.env.example
Normal file
4
.env.example
Normal file
@@ -0,0 +1,4 @@
|
||||
SLACK_APP_TOKEN=
|
||||
SLACK_BOT_TOKEN=
|
||||
FLIGHTAWARE=
|
||||
DATABASE_URL=file:./db.sqlite
|
||||
26
README.md
26
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`
|
||||
Reference in New Issue
Block a user