string-sg / chergpt-basic

No backend, 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 is also mobile friendly!

Deployment - examples

• https://chergpt-physics-lookang.streamlit.app/ from my own forked GitHub
• https://chergpt-physics-cpdd.streamlit.app/ from Kah How's deployment

Features

• Set custom instructions to guide student interactions.
• Download chatlogs
• Generate learning/ teaching analytics based on chatlogs

Need to secure access with a simple global password? Check the authentication guide.

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 and a guided escape room for primary school Chinese Language Learning (wiht particular tasks as checks for understanding)

Deploying

There are three main steps:
1 Setup your database
2 Getting your OpenAI API Key (will soon move to another open source model)
3 Deploy to the web via Streamlit
##1 How to setup backend (database) We recommend using NeonDB, start here

1. Go to this link, login and create your account.
   

2. Create a free project with Singapore as the region. Pick any project and database name you like.

3. Click on the copy icon - this will give you your database (DB) connection String that allows you to store data persistently in CherGPT.
Keep this somewhere safe, you will also need to use this shortly.

OpenAI API Key

• See here if you're unsure how to create it.
  Keep this somewhere safe, you will also need to use this shortly.

3 Deploying to Streamlit

Click here

1. You will be prompted to create a streamlit account here
2. You will be prompted to create a github account
3. Click Deploy app. You should see this screen - edit the domain to anything of your choice! Under Repository, type: String-sg/Chergpt-basic
4. Go to advanced settings and update Secrets.toml with your own values
5. Upon clicking "fork", wait a few mins:
   

Feel free to explore and enhance the functionality of Chergpt-Basic according to your specific needs!

chergpt-basic's Issues

feat: add button to summarize learning insights

feat: integrate user feedback via trubrics

https://github.com/trubrics/trubrics-sdk

fix: dockerize packages

feat: RAG?

attempt: fork, star, deploy

1. fork the repo
2. star the repo (optional haha but easier to access)
3. deploy on streamlit community cloud
4. here is the secrets.toml file structure

OPENAI_API_KEY = "{use your own key}"
ADMIN_PASSWORD = "{whatever you want}"
DB_CONNECTION = "{insert connection string}"*

5. updated README.md as needed - I will also do a quick one now.

*I am using cockroachDB and showed how to do it on the call on 7 jan 7pm. See section on how to setup backend under https://github.com/String-sg/chergpt-basic
** run this locally, don't need to deploy to web yet. will explain complications next week <:

feat: add button to send data via email and purge