From b066325c9c1d2a3bdbc8a1e6c2ea94fdd6ff6721 Mon Sep 17 00:00:00 2001 From: Jack Lowrie Date: Mon, 10 Oct 2022 11:54:41 -0400 Subject: [PATCH] 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 --- README.md | 8 ++++++-- install.sh | 4 ++++ 2 files changed, 10 insertions(+), 2 deletions(-) create mode 100755 install.sh diff --git a/README.md b/README.md index e077660..df08434 100644 --- a/README.md +++ b/README.md @@ -5,7 +5,7 @@ post. -***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) @@ -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, diff --git a/install.sh b/install.sh new file mode 100755 index 0000000..8fa2ae3 --- /dev/null +++ b/install.sh @@ -0,0 +1,4 @@ +python3 -m venv .venv +source .venv/bin/activate +pip install -r requirements.txt +deactivate