Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Added roadmunk doc #11

Merged
merged 1 commit into from
Oct 17, 2023
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
19 changes: 14 additions & 5 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,15 @@ The application is deployed as both a web app (using Streamlit) and a Slack app.

## Getting Started

Before you begin, make sure to install all the required libraries listed in the `requirements.txt` file. It is recommended that you set up your environment within a virtual environment. Additionally, there is a Dockerfile avaialble which will be pushed to ECR.
Before you begin, make sure to install all the required libraries listed in the `requirements.txt` file.

```bash
pip install -r requirements.txt
```

It is recommended that you set up your environment within a [virtual environment](https://docs.streamlit.io/library/get-started/installation). Additionally, there is a Dockerfile avaialble which will be pushed to ECR.

Please reach out for necessary environment variables to run the application.

### Web App

Expand All @@ -16,10 +24,10 @@ To run the web app:

```bash
streamlit run app.py
```

The web app should now be up and running. See below for a preview of how the app should appear when correctly set up.


![streamlit app](./app_images/streamlit.png)

### Slack App
Expand All @@ -30,13 +38,14 @@ The Slack app setup involves a few additional steps, as it requires access to th
2. Run the slackgpt.py script locally by running `sudo python slackgpt.py`. By default, it runs on 127.0.0.1:80.
3. Launch Ngrok with the following command:

```bash
ngrok http 80
```bash
ngrok http 80

```

4. Copy the public URL provided by Ngrok.
5. Access the Slack app [settings page](https://api.slack.com/apps). Kindly reach out for more details on using the existing app
6. Update the Slash Commands request URL to reflect the new URL provided by Ngrok.
7. In your Slack workspace, type /ai-helper and ask your question to interact with the app. See sample request and response below


![slack app](./app_images/slack.png)
2 changes: 1 addition & 1 deletion app.py
Original file line number Diff line number Diff line change
Expand Up @@ -39,7 +39,7 @@ def main():
st.write(Style.RESET_ALL)

# List of files and directory for document embeddings
files = ["Ultimate_introduction_white_paper.pdf", "Planner-complete-guide-to-resource-planning.pdf"]
files = ["Ultimate_introduction_white_paper.pdf", "Planner-complete-guide-to-resource-planning.pdf", "roadmunk_support.pdf"]
persist_directory = "docs/chroma/"

# Create a vector database for document embeddings
Expand Down