JonathanMcCaffrey/IGP-Fan-Reference
1
0
Fork 0
Code Issues Pull Requests Projects Releases Wiki Activity

Update 'Development Setup'

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