Chris-lab / README.md
kz209
initialize
9a1ab03
|
raw
history blame
1.16 kB
---
title: Chris Lab
emoji: πŸ“š
colorFrom: red
colorTo: indigo
sdk: streamlit
sdk_version: 1.36.0
app_file: app.py
pinned: false
---
# Chris Labs
## Description
A collection and display of projects from Chris's group.
## Installation
### Install `poetry` (if not already installed)
Check this [website](https://python-poetry.org/docs/) for installation instructions.
### Create a Cirtual Environment
Navigate to the main directory chris-labs and run the following commands to create a virtual environment:
```sh
python3 -m venv venv
source venv/bin/activate
```
### Install Dependency
Run the following command to install project dependencies:
```sh
poetry install
```
Change the `OPENAI_API_KEY` in `.env`
### Run `streamlit`
Start the Streamlit application by running:
```sh
streamlit run streamlit/home.py
```
Have Fun!
## How to Contribute
### Creating a Branch
Each member should create a branch with their own name and commit to that branch. To merge with main, open a pull request and request review.
### Bug Fixes and Questions
For bug fixes or questions, either open an issue or create a branch prefixed with `bug` in name.