Skip to content

Commit b066325

Browse files
authored
Develop (#13)
* add app registration manifest and piazza icon * install instructions * readme formatting and clarity * add missing install instructions * Update README.md * Update README.md * Update README.md * Update README.md * Update README.md * Update README.md * temp contributing.md * update contributing and add venv to gitignore * bugfix: threaded message replies * install script * update readme * update readme * remove git conflict * update instructions to include install script
1 parent 5a27e05 commit b066325

File tree

2 files changed

+10
-2
lines changed

2 files changed

+10
-2
lines changed

README.md

Lines changed: 6 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -5,7 +5,7 @@ post.
55

66
<img src="https://github.com/jacklowrie/piazza-bot/blob/main/demo.gif" width=100% height=100%>
77

8-
***Note**: I am not affiliated with or endorsed by Piazza or Slack in any way. Neither
8+
**\*Note**: I am not affiliated with or endorsed by Piazza or Slack in any way. Neither
99
is this bot.
1010

1111
## Installation (adding to your workspace, and updates)
@@ -33,11 +33,15 @@ the app up on your host.
3333
into "Features"->"Oauth & Permissions", and note the Bot User OAuth Token.
3434

3535
### Host the app (3-5 min)
36+
3637
1. _Clone this repo._ This is the easiest way to handle updates, since you
3738
can just pull from `main` and restart the app whenever there's an update.
3839
Alternatively, if you need to modify the app for your workspace, fork instead.
3940
2. _Install dependencies._ Set up a virtual environment, and install the
40-
required modules from `requirements.txt`.
41+
required modules from `requirements.txt`. There's an install script `install.sh`
42+
which contains the commands you'll need to run. Either run each command
43+
individually, or try running the script **make sure python3 is installed on
44+
your systembefore running**.
4145
3. _Add tokens._ create a `.env` file from `.env-sample` and add the
4246
corresponding tokens you noted when registering the app.
4347
4. _Add Course ID._ Go to your course's dashboard (if you're viewing a question,

install.sh

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,4 @@
1+
python3 -m venv .venv
2+
source .venv/bin/activate
3+
pip install -r requirements.txt
4+
deactivate

0 commit comments

Comments
 (0)