Add detailed setup instructions to README.md with sample environment file#41
Add detailed setup instructions to README.md with sample environment file#41
Conversation
Co-authored-by: sethjuarez <115409+sethjuarez@users.noreply.github.com>
There was a problem hiding this comment.
This file should actually live in the root directory (to make sure VSCode F5 run works correctly).
There was a problem hiding this comment.
I've moved the .env.example file from the api/ directory to the root directory as requested. This should ensure VSCode F5 run works correctly since the dotenv library looks for the .env file in the project root. The change is in commit 62b689c.
README.md
Outdated
| - Magic function calling mapping for generic local function calls (A) | ||
| - Backchannel with utility function calls (A+S)* |
There was a problem hiding this comment.
I've removed the bullet points from lines 5-6 in README.md as requested. The changes are in commit 0a05648.
|
Can we change this README to a SETUP.md instead? |
Co-authored-by: sethjuarez <115409+sethjuarez@users.noreply.github.com>
Co-authored-by: sethjuarez <115409+sethjuarez@users.noreply.github.com>
I've moved all the detailed setup instructions from README.md to a new SETUP.md file as requested. The README.md now simply introduces Sustineo and points to SETUP.md for detailed instructions. The changes are in commit 0a05648. |
sethjuarez
left a comment
sethjuarez
left a comment
There was a problem hiding this comment.
Overall pretty good - perhaps we should mention that the Cosmos dB storage contains the app settings for each scenario and that the storage account saves any images generated.
| - WebSocket Endpoint: `ws://localhost:8000` | ||
| - API Endpoint: `http://localhost:8000` | ||
| - Web Endpoint: `http://localhost:5173` |
There was a problem hiding this comment.
You can mention here that there is a GitHub Action in this project that rewrites these to match the Azure Container App by using the Azure CLI to query for the correct FQDNs
There was a problem hiding this comment.
I've added a note in the Web Environment Setup section about the GitHub Action that automatically rewrites the endpoints using Azure CLI to query for the correct FQDNs when deploying to Azure Container Apps. The change is in commit 8a841b7.
SETUP.md
Outdated
| 2. Start the FastAPI application: | ||
| ```bash | ||
| fastapi run main.py | ||
| ``` |
There was a problem hiding this comment.
This is awesome maybe add something about how the vscode settings allow for this to be run using F5. This also may not work given that I usually put a virtual environment at the root of the project so it would need to be run from the root - can we fix that?
There was a problem hiding this comment.
I've updated the API run instructions to work from the root directory using uvicorn api.main:app --reload instead of running from the api/ directory. I've also added information about the VSCode F5 functionality that lets users run and debug the API with a single keystroke. The changes are in commit 8a841b7.
…guration Co-authored-by: sethjuarez <115409+sethjuarez@users.noreply.github.com>
I've added information about the purpose of the Cosmos DB and Storage resources in the SETUP.md file, clarifying that Cosmos DB stores app settings for each scenario and the Storage account saves generated images. These changes are in commit 8a841b7. |
|
Bump |
|
Ditto the comment I just made on #40 😀 |
This PR adds comprehensive setup instructions to the README.md file, making it easier for new users to set up and run the Sustineo application. The updates include:
Additionally, I've added a sample
.env.examplefile in the API directory that users can copy and customize with their own credentials.These changes ensure that new users can quickly understand what's needed to get Sustineo running without having to dig through the codebase.
Fixes #37.
💡 You can make Copilot smarter by setting up custom instructions, customizing its development environment and configuring Model Context Protocol (MCP) servers. Learn more Copilot coding agent tips in the docs.