From 8669070c5cc3192eaad2723101000b2da668da26 Mon Sep 17 00:00:00 2001 From: lookang Date: Sun, 14 Jan 2024 00:10:46 +0800 Subject: [PATCH] Update README.md --- README.md | 61 ++++++++++++++++++++++++++++++++----------------------- 1 file changed, 36 insertions(+), 25 deletions(-) diff --git a/README.md b/README.md index 6af0919..ba4c8ad 100644 --- a/README.md +++ b/README.md @@ -1,35 +1,46 @@ -# chergpt-basic: custom chat assistant -No login, vanilla ChatGPT-like interface with scaffolded code for immediate deployment +# Chergpt-Basic: Custom Chat Assistant + +Chergpt-Basic is a simplified, login-free ChatGPT-like interface designed for quick deployment. It allows users to interact with a chat assistant based on OpenAI's GPT-3.5 model. The README provides clear instructions on setting up the backend, customization, and potential use cases. + +## Deployment +- https://chergpt-physics-lookang.streamlit.app/ from my own forked GitHub +- https://chergpt-physics-cpdd.streamlit.app/ from Kah How's deployment ## Features -- [x] Set custom instructions to guide student interactions
-- [WIP] Trigger immediate summaries of learning insights at the end of the session
+- [x] Set custom instructions to guide student interactions. +- [WIP] Trigger immediate summaries of learning insights at the end of the session. -Need to gate access with a simple global password? See [here](https://docs.streamlit.io/knowledge-base/deploy/authentication-without-sso) +Need to secure access with a simple global password? Check the [authentication guide](https://docs.streamlit.io/knowledge-base/deploy/authentication-without-sso). -## Use cases -The most straightforward use of custom instructions is to create user personas for students to interact with.
-E.g. historical figures, patients with particular medical conditions +## Use Cases +Chergpt-Basic enables a variety of use cases, with the primary one being the creation of user personas for students to interact with. Examples include historical figures or patients with specific medical conditions. -## How to setup backend -A) **NeonDB** You can follow instructions on NeonDB [here](https://start.open.gov.sg/docs/getting-started/prerequisites)
-B) **CockroachDB**
-* Create a CockroachDB Serverless cluster (free)
-* Sign up for a CockroachDB Cloud account.
-* Log in to your CockroachDB Cloud account.
-* On the Clusters page, click Create Cluster.
-* On the Create your cluster page, select Serverless.
-* Click Create cluster.
+## How to Set Up Backend +### A) NeonDB +Follow the instructions on NeonDB [here](https://start.open.gov.sg/docs/getting-started/prerequisites). -Your cluster will be created in a few seconds and the Create SQL user dialog will display. +### B) CockroachDB +1. Create a CockroachDB Serverless cluster (free). +2. Sign up for a CockroachDB Cloud account. +3. Log in to your CockroachDB Cloud account. +4. On the Clusters page, click Create Cluster. +5. On the Create your cluster page, select Serverless. +6. Click Create cluster. -For either (A) or (B), copy the URL and put it as `DB_CONNECTION = "{DB connection String}"` under `secrets.toml` +Your cluster will be created in a few seconds, and the Create SQL user dialog will display. -## secrets.toml file structure -You will need to specify 3 items:
-``` -OPENAI_API_KEY = "{api_key}" #See [here](https://teachertech.beehiiv.com/p/api-openai) if you unsure on how to create
-DB_CONNECTION = "{db_connection string}" #Refer to instructions above on **How to setup backend** if unsure -ADMIN_PASSWORD = "{any password you want}" #This is used to gate access on how can update custom instructions +For either (A) or (B), copy the URL and put it as `DB_CONNECTION = "{DB connection String}"` under `secrets.toml`. + +## Secrets.toml File Structure +In the `secrets.toml` file, specify three items: you have to change it to your own + +```toml +OPENAI_API_KEY = "sk-Co6R5h4RcT....................................." +ADMIN_PASSWORD= "passwordyourchoice" +DB_CONNECTION = "postgresql://chergpt:PGPASSWORD@ep-weathered-shadow-a1uz6hly.ap-southeast-1.aws.neon.tech/neondb?sslmode=require" ``` +- See [here](https://teachertech.beehiiv.com/p/api-openai) if you're unsure how to create it. +- Used to gate access for updating custom instructions. +- Refer to instructions above on **How to Set Up Backend** if unsure. +Feel free to explore and enhance the functionality of Chergpt-Basic according to your specific needs!