Developer Quickstart
Thanks for contributing to UIUC.chat ❤️
Start here
Set up Infiscal for Environment Variables
Instead of sharing .env files manually, we use Infiscal as a central password manager for devs. We use its CLI and web interface.
See the CLI install docs for Linux/Windows instructions. Or the CLI usage docs.
# install
brew install infisical/get-cli/infisical# add the repository
curl -1sLf \
'https://dl.cloudsmith.io/public/infisical/infisical-cli/setup.deb.sh' \
| sudo -E bash
# install
sudo apt-get update && sudo apt-get install -y infisicalWhere are my .env variables?
If it's running on localhost, the env vars come from Infisical, our shared secrets manager. You can add new env vars at env.uiuc.chat
If it's in production, or any cloud service, the env vars are stored directly in that cloud service. Those include Vercel, Railway, Beam.cloud and more. You can edit env vars in those services, just be careful.
Frontend Setup
Frontend repo: https://github.com/Center-for-AI-Innovation/uiuc-chat-frontend
(1/2) Install dev dependencies
Use Node version 18.xx LTS
Install dev dependencies
(2/2) Set up secrets
Last step: start dev server!
You will need to run the below command once for the initial setup
Run the app on your local machine
npm run dev is the most important command you'll use every dev session.
Backend Setup
Backend repo: https://github.com/Center-for-AI-Innovation/ai-ta-backend
(1/2) Install dev dependencies
Use a python virtual environment, here I'll use conda.
Fast and easy conda install (via CLI is easiest), if you don't have it yet.
Use python 3.10.
Create and activate Conda env
Install dependencies
(2/2) Set up secrets
Last step: start dev server!
Now you can write new endpoints in ai-ta-backend/main.py and call them using Postman.
Thanks! For any questions at all just email me (rohan13@illinois.edu).
Last updated