From b3a207a53fc919077273b7089f701a26d4152215 Mon Sep 17 00:00:00 2001 From: "Brady Stroud [SSW]" Date: Tue, 10 Oct 2023 13:55:08 +1000 Subject: [PATCH] =?UTF-8?q?=F0=9F=93=84=20Clean=20up=20readme=20(#66)?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit * Clean up readme * Update README.md --- README.md | 59 +++++++++++++++---------------------------------------- 1 file changed, 16 insertions(+), 43 deletions(-) diff --git a/README.md b/README.md index 5549842..0b30d38 100644 --- a/README.md +++ b/README.md @@ -1,32 +1,31 @@ -πŸ€– # πŸ•’ TimesheetGPT - https://timesheet-gpt.azurewebsites.net/ 🎯 The goal is to make timesheets easier (especially for non-devs) by: -- πŸ“Š Getting data from various sources (currently Microsoft Graph, soon GitHub, Trello, maybe DevOps) -- πŸ€– Using ChatGPT API to summarize all the data -- πŸ“ Using all the summaries to make a Timesheet +- πŸ“Š Getting data from various sources (currently Microsoft Graph (sent emails, meetings, calls), soon GitHub, maybe Trello and DevOps) +- πŸ€– Using Semantic Kernal to summarize all the data +- πŸ“ Using all the summaries to make a timesheet -MicrosoftTeams-image (1) +![](https://github.com/bradystroud/TimesheetGPT/assets/38869720/c953851f-b5f8-4f95-aed9-bcbcb21d1e3d) +**Figure: ** ## πŸ›  Technical Stuff -## πŸš€ Working on TimesheetGPT +### πŸš€ Working on TimesheetGPT Welcome, and thank you for contributing to TimesheetGPT! Before diving into the code, here’s how to get everything set up and running on your local machine. -### 🧰 Prerequisites +#### 🧰 Prerequisites Ensure you have the following installed: - [.NET 8 SDK](https://dotnet.microsoft.com/download/dotnet/8.0) - [Visual Studio 2022](https://visualstudio.microsoft.com/vs/) or a similar IDE with support for .NET 8 - [Git](https://git-scm.com/) -### πŸ–₯ Setup +#### πŸ–₯ Setup -#### 1. **Clone the Repository** +##### 1. **Clone the Repository** Open a terminal or command prompt and run: ```bash @@ -37,7 +36,7 @@ Navigate to the project folder: cd TimesheetGPT/src/TimesheetGPT.WebUI ``` -#### 2. **Run the Application** +##### 2. **Run the Application** Run the application using the following command: ```bash @@ -45,7 +44,7 @@ Run the application using the following command: ``` Now, you should be able to navigate to `https://localhost:7270` (or another port if you have configured it differently) in your web browser to view the application. -### πŸ›  Develop and Contribute +#### πŸ›  Develop and Contribute - **Branching Strategy:** Ensure you create a new branch for the feature or fix you are working on. Do not push changes directly to the main branch. As per https://www.ssw.com.au/rules/do-you-know-when-to-branch-in-git @@ -55,36 +54,10 @@ As per https://www.ssw.com.au/rules/use-emojis-in-your-commits - **Pull Requests:** Make sure your code is well-commented, follows the established coding style, and passes any tests before submitting a pull request. As per https://www.ssw.com.au/rules/write-a-good-pull-request -### πŸ”— Additional Links -- **Blazor Documentation:** For help with Blazor, visit [Blazor Documentation](https://docs.microsoft.com/en-us/aspnet/core/blazor/?view=aspnetcore-5.0). -- **.NET Documentation:** For deeper dives into .NET, check out [.NET Documentation](https://docs.microsoft.com/en-us/dotnet/). +#### πŸ”— Additional Links +- [Blazor Documentation](https://docs.microsoft.com/en-us/aspnet/core/blazor/?view=aspnetcore-5.0) +- [.NET Documentation](https://docs.microsoft.com/en-us/dotnet/) +- [Semantic Kernel](https://learn.microsoft.com/en-us/semantic-kernel/overview/) -### πŸ™Œ Thanks for Contributing! +#### πŸ™Œ Thanks for Contributing! Your contributions and insights are integral to the growth and functionality of TimesheetGPT. Feel free to submit issues, create pull requests, or document any bugs found. Let's make TimesheetGPT stellar together! - ---- - -Feel free to modify as per your project’s specific needs and guidelines. This is a generic guide that will help developers set up and start contributing to your project. - -πŸ‘‰ Right now, the API isn't used at all; the Blazor Server app handles auth and then talks directly to the Application layer. This is okay for now, but the plan is to use the API to handle all the work, making it easier to integrate this into timesheeting software later. - -### 🀨 Challenges and Current Plan - -#### 🎫 Token Handling - -πŸ’­ We're facing some challenges around where to handle OAuth token generation. Should this happen on the client side or directly within the API? For now, the thought is that acquiring the token on the client side makes the most sense, as it can then be forwarded to the API. - -#### πŸ”’ Token Validation - -🀷 Another question is how the API should validate the received token. Should there be explicit validation, or can we simply make the API request and handle any failures as they come? This is still under consideration. - -#### πŸš€ Sequence of Operations (Desired, but not yet implemented) - -πŸ“‹ The desired sequence of operations is as follows: -1. User logs in on the Blazor Client. -2. Generate an OAuth token with the required permissions (scopes). -3. Pass this token to the external API. -4. The external API uses the token to interact with Microsoft Graph or other services. - -πŸ‘¨β€πŸ’» We're focusing on making it work with Blazor Server first and will address these token-handling complexities later. -