From 02804d9ac2503c2db38bc738bff9dda45ae8f332 Mon Sep 17 00:00:00 2001 From: Jonathan McCaffrey Date: Sun, 11 May 2025 16:53:27 +0000 Subject: [PATCH] Update 'Development Setup' --- Development-Setup.md | 176 ++++++++++++++++++++++--------------------- 1 file changed, 89 insertions(+), 87 deletions(-) diff --git a/Development-Setup.md b/Development-Setup.md index 982c5f0..1187b14 100644 --- a/Development-Setup.md +++ b/Development-Setup.md @@ -1,87 +1,89 @@ -# Overview - -This document will contain general setup notes for the project. - -## Prerequisite - -To understand this document, you should have some software development experience. Particularly -using GitHub and Visual Studio. - -- [GitHub Documentation](https://docs.github.com/en/get-started) - -- [Visual Studio Documentation](https://visualstudio.microsoft.com/vs/getting-started/) - -To create updates to the website, you should understand HTML/CSS and C#. - -- [C# Documentation](https://docs.microsoft.com/en-us/dotnet/csharp/) -- [Mozilla's HTML Documentation](https://developer.mozilla.org/en-US/docs/Learn/HTML/Introduction_to_HTML/Getting_started) -- [W3SCHOOLS' HTML Documentation](https://www.w3schools.com/html/) - -Further, you should understand the related product and client needs. So it is recommended to play "IMMORTAL: -Gates of Pyre". - -- [IGP Website](https://gatesofpyre.com/) -- [Alpha Client](https://discord.com/channels/636265083936309248/911737006193786900) - -> _Don't have an alpha key? Contact me on @JonathanMcCaffrey#3544 on Discord._ - - -## Installation - -Download and install Visual Studio preview. - -**Note:** Visual Studio Preview currently doesn't work on Mac for this project. Use a PC or Rider. - -[https://visualstudio.microsoft.com/vs/preview/](https://visualstudio.microsoft.com/vs/preview/) - -When installing, ensure you have selected "Workloads | **ASP.NET and web development**" and "Individual components | ** -.NET WebAssembly build tools**". - -## Download Project - -Get this project from GitHub. - -```bash -git clone https://github.com/JonathanMcCaffrey/IGP-Fan-Reference.git -``` - -## Project Tree - -``` -C:. -├───.github -│ └───workflows # Workflows to deploy website -├───Components # Components used be website -├───Contexts -├───IGP -│ ├───Pages # Website pages -│ └───wwwroot -│ ├───css -│ ├───generated # Files generated by IGP_Convert. Do not edit -│ ├───image -│ └───javascript -├───IGP_Convert # Converts SQL into JSON for Blazor Wasm -├───Model # Data models -└───Services # Web services -``` - -## Running - -- Open `IGP/IGP.sln`. -- Click the green RUN button in Visual Studio. -- A local copy of the IGP Website should have launched on your machine. - -## Publishing - -Code committed to the `main` branch will automatically be deployed to [production](https://www.igpfanreference.com/). - -Code committed to the `develop` branch will automatically be deployed -to [development](https://calm-mud-04916b210.1.azurestaticapps.net/). - -_This is handled via the files in `.github/workflow`. Look into -these [GitHub Actions Documents](https://docs.github.com/en/actions) if curious about how this CI system works._ - -## Troubleshooting - -Nothing that some good internet searches cannot resolve. But you can also contact the project maintainer -on [Discord](https://discord.gg/uMq8bMGeeN). +> Disclaimer: This document is out of date. Noticably this website has since moved away from GitHub, and it's infrastructure has entirely changed + +# Overview + +This document will contain general setup notes for the project. + +## Prerequisite + +To understand this document, you should have some software development experience. Particularly +using GitHub and Visual Studio. + +- [GitHub Documentation](https://docs.github.com/en/get-started) + +- [Visual Studio Documentation](https://visualstudio.microsoft.com/vs/getting-started/) + +To create updates to the website, you should understand HTML/CSS and C#. + +- [C# Documentation](https://docs.microsoft.com/en-us/dotnet/csharp/) +- [Mozilla's HTML Documentation](https://developer.mozilla.org/en-US/docs/Learn/HTML/Introduction_to_HTML/Getting_started) +- [W3SCHOOLS' HTML Documentation](https://www.w3schools.com/html/) + +Further, you should understand the related product and client needs. So it is recommended to play "IMMORTAL: +Gates of Pyre". + +- [IGP Website](https://gatesofpyre.com/) +- [Alpha Client](https://discord.com/channels/636265083936309248/911737006193786900) + +> _Don't have an alpha key? Contact me on @JonathanMcCaffrey#3544 on Discord._ + + +## Installation + +Download and install Visual Studio preview. + +**Note:** Visual Studio Preview currently doesn't work on Mac for this project. Use a PC or Rider. + +[https://visualstudio.microsoft.com/vs/preview/](https://visualstudio.microsoft.com/vs/preview/) + +When installing, ensure you have selected "Workloads | **ASP.NET and web development**" and "Individual components | ** +.NET WebAssembly build tools**". + +## Download Project + +Get this project from GitHub. + +```bash +git clone https://github.com/JonathanMcCaffrey/IGP-Fan-Reference.git +``` + +## Project Tree + +``` +C:. +├───.github +│ └───workflows # Workflows to deploy website +├───Components # Components used be website +├───Contexts +├───IGP +│ ├───Pages # Website pages +│ └───wwwroot +│ ├───css +│ ├───generated # Files generated by IGP_Convert. Do not edit +│ ├───image +│ └───javascript +├───IGP_Convert # Converts SQL into JSON for Blazor Wasm +├───Model # Data models +└───Services # Web services +``` + +## Running + +- Open `IGP/IGP.sln`. +- Click the green RUN button in Visual Studio. +- A local copy of the IGP Website should have launched on your machine. + +## Publishing + +Code committed to the `main` branch will automatically be deployed to [production](https://www.igpfanreference.com/). + +Code committed to the `develop` branch will automatically be deployed +to [development](https://calm-mud-04916b210.1.azurestaticapps.net/). + +_This is handled via the files in `.github/workflow`. Look into +these [GitHub Actions Documents](https://docs.github.com/en/actions) if curious about how this CI system works._ + +## Troubleshooting + +Nothing that some good internet searches cannot resolve. But you can also contact the project maintainer +on [Discord](https://discord.gg/uMq8bMGeeN).