From 09010b5eb605450b7861a655e0c01e01215adb47 Mon Sep 17 00:00:00 2001 From: Kastan Day Date: Mon, 11 Sep 2023 13:32:33 -0700 Subject: [PATCH] =?UTF-8?q?=F0=9F=93=9C=20Add=20.env.template=20to=20insta?= =?UTF-8?q?ll=20instructions?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit --- README.md | 5 +++-- 1 file changed, 3 insertions(+), 2 deletions(-) diff --git a/README.md b/README.md index 501db0e2..c0c2fe12 100644 --- a/README.md +++ b/README.md @@ -13,8 +13,9 @@ Automatic [API Reference](https://uiuc-chatbot.github.io/ai-ta-backend/reference ## 📣 Development -- Install Python requirements `pip install -r requirements.txt` -- Start the server for development (with live reloads) `cd ai_ta_backend` then `flask --app ai_ta_backend.main:app --debug run --port 8000` +1. Rename `.env.template` to `.env` and fill in the required variables +2. Install Python requirements `pip install -r requirements.txt` +3. Start the server for development (with live reloads) `cd ai_ta_backend` then `flask --app ai_ta_backend.main:app --debug run --port 8000` The docs are auto-built and deployed to [our docs website](https://uiuc-chatbot.github.io/ai-ta-backend/) on every push. Or you can build the docs locally when writing: - `mkdocs serve`