Skip to content

Commit

Permalink
Add some doco (#15)
Browse files Browse the repository at this point in the history
* add f5 to readme

* remove http and iis launch

* Add links to rules

---------

Co-authored-by: Brady Stroud [SSW] <[email protected]>
  • Loading branch information
SamBWagner and bradystroud authored Oct 6, 2023
1 parent 940e534 commit 8737bc9
Show file tree
Hide file tree
Showing 2 changed files with 54 additions and 17 deletions.
54 changes: 53 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,9 +8,61 @@

<img width="1800" alt="MicrosoftTeams-image (1)" src="https://github.com/bradystroud/TimesheetGPT/assets/38869720/c953851f-b5f8-4f95-aed9-bcbcb21d1e3d">


## 🛠 Technical Stuff

## 🚀 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

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

#### 1. **Clone the Repository**

Open a terminal or command prompt and run:
```bash
git clone https://github.com/bradystroud/TimesheetGPT.git
```
Navigate to the project folder:
```bash
cd TimesheetGPT
```

#### 2. **Run the Application**

Run the application using the following command:
```bash
dotnet run
```
Now, you should be able to navigate to `https://localhost:5001` (or another port if you have configured it differently) in your web browser to view the application.

### 🛠 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
- **Commit Messages:** Write clear and concise commit messages describing the changes you are making and the reason.
As per https://www.ssw.com.au/rules/use-emojis-in-your-commits
- **Testing:** Ensure to test your features or fixes before submitting a pull request.
- **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/).

### 🙌 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
Expand Down
17 changes: 1 addition & 16 deletions src/TimesheetGPT.WebUI/Properties/launchSettings.json
Original file line number Diff line number Diff line change
@@ -1,25 +1,10 @@
{
"iisSettings": {
"windowsAuthentication": false,
"anonymousAuthentication": true,
"iisExpress": {
"applicationUrl": "http://localhost:52979",
"sslPort": 44347
}
},
"profiles": {
"https": {
"commandName": "Project",
"dotnetRunMessages": true,
"launchBrowser": true,
"applicationUrl": "https://localhost:7270;http://localhost:5037",
"environmentVariables": {
"ASPNETCORE_ENVIRONMENT": "Development"
}
},
"IIS Express": {
"commandName": "IISExpress",
"launchBrowser": true,
"applicationUrl": "https://localhost:7270;",
"environmentVariables": {
"ASPNETCORE_ENVIRONMENT": "Development"
}
Expand Down

0 comments on commit 8737bc9

Please sign in to comment.