Skip to content

Commit

Permalink
Develop (#13)
Browse files Browse the repository at this point in the history
* 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
  • Loading branch information
jacklowrie authored Oct 10, 2022
1 parent 5a27e05 commit b066325
Show file tree
Hide file tree
Showing 2 changed files with 10 additions and 2 deletions.
8 changes: 6 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@ post.

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

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

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

### Host the app (3-5 min)

1. _Clone this repo._ This is the easiest way to handle updates, since you
can just pull from `main` and restart the app whenever there's an update.
Alternatively, if you need to modify the app for your workspace, fork instead.
2. _Install dependencies._ Set up a virtual environment, and install the
required modules from `requirements.txt`.
required modules from `requirements.txt`. There's an install script `install.sh`
which contains the commands you'll need to run. Either run each command
individually, or try running the script **make sure python3 is installed on
your systembefore running**.
3. _Add tokens._ create a `.env` file from `.env-sample` and add the
corresponding tokens you noted when registering the app.
4. _Add Course ID._ Go to your course's dashboard (if you're viewing a question,
Expand Down
4 changes: 4 additions & 0 deletions install.sh
Original file line number Diff line number Diff line change
@@ -0,0 +1,4 @@
python3 -m venv .venv
source .venv/bin/activate
pip install -r requirements.txt
deactivate

0 comments on commit b066325

Please sign in to comment.