This repository contains two main applications: the Community Resource Guide and the BearBrown Bot. Both applications share similar elements but are designed for different purposes.
The Community Resource Guide is a comprehensive database of organizations in Durham, NC. It helps users find community resources, volunteer opportunities, fundraisers, and other related information quickly and easily.
The BearBrown Bot is designed to be embedded on the BearBrown.co website. Its purpose is to assist users in finding resources and information within the BearBrown website, providing an enhanced and interactive user experience.
- Comprehensive database of community organizations in Durham, NC.
- Search functionality to find specific organizations and resources.
- Detailed information about each organization's programs, mission, impact, and more.
- Suggested questions to guide users in their search for information.
- Interactive chatbot interface to answer user queries.
- Embedded chatbot for the BearBrown.co website.
- Helps users find resources and information within the website.
- Provides detailed and interactive responses to user queries.
- Enhances user experience with guided suggestions and follow-up questions.
- Python 3.8 or higher
- Streamlit
- Sentence Transformers
- OpenAI API key
- Google Cloud Storage credentials
-
Clone the repository:
git clone https://github.com/yourusername/Community-Resource-and-BearBrown-Bot.git cd Community-Resource-and-BearBrown-Bot
-
Create and activate a virtual environment:
python -m venv venv source venv/bin/activate # On Windows, use `venv\Scripts\activate`
-
Install the required packages:
pip install -r requirements.txt
-
Set up your environment variables:
- Create a
.env
file in the root directory. - Add your OpenAI API key and Google Cloud Storage credentials to the
.env
file.
- Create a
-
Navigate to the
community_resource
directory:cd community_resource
-
Run the Streamlit application:
streamlit run app.py
-
Navigate to the
bearbrown_bot
directory:cd bearbrown_bot
-
Run the Streamlit application:
streamlit run app.py
- Open your web browser and navigate to the local address provided by Streamlit (usually
http://localhost:8501
). - Interact with the chatbot to find information about community resources in Durham, NC.
- Use the suggested questions to quickly get answers to common queries.
- Embed the BearBrown Bot on the BearBrown.co website.
- Users visiting the website can interact with the bot to find resources and information.
- The bot will guide users through their queries and provide detailed responses and follow-up questions.
We welcome contributions to enhance the features and capabilities of both the Community Resource Guide and BearBrown Bot. Please follow these steps to contribute:
- Fork the repository.
- Create a new branch:
git checkout -b feature/YourFeatureName
- Make your changes and commit them:
git commit -m "Add Your Feature"
- Push to the branch:
git push origin feature/YourFeatureName
- Open a pull request describing your changes.
This project is licensed under the MIT License. See the LICENSE file for details.
For any questions or inquiries, please contact us at:
- Website: Community Resource
- Website: BearBrown