Skip to content

Commit

Permalink
πŸ“œ Add .env.template to install instructions
Browse files Browse the repository at this point in the history
  • Loading branch information
KastanDay authored Sep 11, 2023
1 parent c6c21e6 commit 09010b5
Showing 1 changed file with 3 additions and 2 deletions.
5 changes: 3 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -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`
Expand Down

0 comments on commit 09010b5

Please sign in to comment.