Skip to content

Commit 3105fd9

Browse files
docs: update readme
1 parent 9de7b8a commit 3105fd9

File tree

1 file changed

+17
-4
lines changed

1 file changed

+17
-4
lines changed

README.md

+17-4
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,7 @@
11
<img alt="gitleaks badge" src="https://img.shields.io/badge/protected%20by-gitleaks-blue">
22

33
# meetup_bot
4+
45
**Table of Contents**
56
* [meetup\_bot](#meetup_bot)
67
* [Summary](#summary)
@@ -18,9 +19,11 @@
1819
* [Further Reading](#further-reading)
1920

2021
## Summary
22+
2123
Use Meetup Pro API to send Slack messages before events occur.
2224

2325
## Minimum Requirements
26+
2427
* [Python 3.11+](https://www.python.org/downloads/)
2528
* [Heroku CLI](https://devcenter.heroku.com/articles/heroku-cli)
2629
* [Create a Meetup API key](https://secure.meetup.com/meetup_api/key/)
@@ -29,14 +32,17 @@ Use Meetup Pro API to send Slack messages before events occur.
2932
* [Create a Slack bot](https://api.slack.com/bot-users)
3033

3134
## Recommended Requirements
35+
3236
* [Devbox](https://www.jetpack.io/devbox/docs/quickstart/)
3337
* [Docker](https://www.docker.com/products/docker-desktop)
3438

3539
## Quickstart
40+
3641
* Clone repo
3742
* Copy `.env.example` to `.env` and fill out environment variables
3843

3944
### Python only
45+
4046
```bash
4147
cd ./app
4248

@@ -48,6 +54,7 @@ python main.py
4854
```
4955

5056
### Shell wrapper
57+
5158
```bash
5259
cd ./app
5360

@@ -62,6 +69,7 @@ cd ./app
6269
```
6370

6471
### Devbox
72+
6573
I.e., [Nix Package Manager](https://search.nixos.org/packages)
6674
```bash
6775
# enter dev environment
@@ -81,6 +89,7 @@ devbox run test
8189
```
8290

8391
### Docker
92+
8493
```bash
8594
cd ./app
8695

@@ -92,14 +101,15 @@ docker run --name meetup_bot -it --rm --env-file .env -p 3000:3000 meetup_bot ba
92101
```
93102

94103
### Docker Compose
104+
95105
```bash
96106
cd ./app
97107

98108
# build image
99-
docker-compose build --remove-orphans
109+
docker compose build --remove-orphans
100110

101111
# run image
102-
docker-compose up -d
112+
docker compose up -d
103113

104114
# enter server container
105115
docker exec -it meetup_bot-cont bash
@@ -108,13 +118,14 @@ docker exec -it meetup_bot-cont bash
108118
exit
109119

110120
# stop image
111-
docker-compose stop
121+
docker compose stop
112122

113123
# remove image
114-
docker-compose down --volumes
124+
docker compose down --volumes
115125
```
116126

117127
## TODO
128+
118129
* Refactor authentication
119130
* passlib + bcrypt -> bcrypt (see: [AttributeError: module 'bcrypt' has no attribute '__about__' with new 4.1.1 version · Issue #684 · pyca/bcrypt](https://github.com/pyca/bcrypt/issues/684#issuecomment-1902590553))
120131
* Secured endpoints
@@ -137,6 +148,7 @@ docker-compose down --volumes
137148
* Coralogix logging
138149

139150
## Stretch Goals
151+
140152
* Indicate online vs. in-person
141153
* Time Frame
142154
* 2 hours before
@@ -180,6 +192,7 @@ docker-compose down --volumes
180192
<!-- ALL-CONTRIBUTORS-LIST:END -->
181193

182194
## Further Reading
195+
183196
[API Doc Authentication | Meetup](https://www.meetup.com/api/authentication/#p04-jwt-flow-section)
184197

185198
[How to Handle JWTs in Python](https://auth0.com/blog/how-to-handle-jwt-in-python/)

0 commit comments

Comments
 (0)