Update documentation

GregFinzer · Aug 13, 2024 · 5887f99 · 5887f99
1 parent 9e02fc3
commit 5887f99
Show file tree

Hide file tree

Showing 4 changed files with 12 additions and 28 deletions.
diff --git a/BlazorServer.md b/BlazorServer.md
diff --git a/Documentation/Architecture.md b/Documentation/Architecture.md
@@ -10,12 +10,15 @@ BedBrigadeNational\Documentation\Design
 <hr />
 
 ## Application Infrastructure Diagram
+(This is out of date)
 ![Application Infrastructure Diagram](Design/Application%20Infrastructure%20Diagram.png)
 
 <hr />
 
 ## Application Architecture Diagram
+(This is out of date)
 ![Application Architecture Diagram](Design/Application%20Architecture%20Diagram.png)
 
 ## Entity Relationship Diagram
+(This is out of date)
 ![Entity Relationship Diagram](Design/EntityRelationshipDiagram.png)
diff --git a/Documentation/Getting Started.md b/Documentation/Getting Started.md
@@ -12,7 +12,7 @@ https://www.syncfusion.com/sales/communitylicense
 * <a href="https://community.chocolatey.org/packages/visualstudio2022community">Visual Studio 2022</a> for the IDE.
 * <a href="https://community.chocolatey.org/packages/sql-server-express" target="_blank">SQL Server Express</a> for local database development.
 * To run the project the <a href="https://community.chocolatey.org/packages/visualstudio2022-workload-netweb">ASP.NET Workload</a> is required. 
-* .NET 7 SDK:  https://dotnet.microsoft.com/
+* .NET 8 SDK:  https://dotnet.microsoft.com/
 * To run the NUnit tests, <a href="https://www.jetbrains.com/resharper/">Resharper</a> or <a href="https://marketplace.visualstudio.com/items?itemName=NUnitDevelopers.NUnit3TestAdapter">NUnit Test Adapter</a> is required
 * Install SyncFusion:  https://www.syncfusion.com/account/downloads
 * Install Web Compiler Visual Studio Extension.  This is required for right clicking on the theme.scss and generating the theme.css and theme.min.css
@@ -33,12 +33,16 @@ git clone https://github.com/GregFinzer/BedBrigadeNational
     ```
 
 ### 5. Set Gold License Key
-In order to run the NUnit Tests and check for Quality Locally, please set a Windows Environment variable of Gold to what is in this document:  Bed Brigade National Website Information.docx
+In order to run the NUnit Tests and check for Quality Locally, please set a Windows Environment variable of GOLD to what is in this document:  Bed Brigade National Website Information.docx
 * Login to the SmarterAsp.NET FTP Site using credentials given.
 * Download the Secrets Folder.
 * Open the file Bed Brigade National Website Information.docx to see the Gold Suite License Key.
 
-### 6. Run the Application
+### 5. Set Syncfusion License Key
+* Set an environment variable of Syncfusion to your community license.
+
+### 7. Run the Application
+* Close and Reopen Visual Studio (this is necessary after setting the environment variables).
 * Right click the BedBrigade.Client
 * Set as startup project
 * Press the play button

diff --git a/README.md b/README.md
@@ -2,13 +2,13 @@
 
 We are looking :mag_right: for volunteer developers to help with this effort.  Please email  <a href="mailto:gfinzer@hotmail.com">Greg Finzer</a> if interested.
 
-In 2023 we are developing a national website for The Bed Brigade.  Bed Brigade of Grove City, Ohio is a 501 3c registered charity.  Bed Brigade builds and delivers Twin XL beds to people in need.  80% of the beds delivered serve children that do not have a bed.  Several chapters of Bed Brigade opened up throughout Ohio in 2022.  There is a need  for a national website for all Bed Brigade Chapters to use. 
+In 2023-2024 we are developing a national website for The Bed Brigade.  Bed Brigade of Grove City, Ohio is a 501 3c registered charity.  Bed Brigade builds and delivers Twin XL beds to people in need.  80% of the beds delivered serve children that do not have a bed.  Several chapters of Bed Brigade opened up throughout Ohio in 2022.  There is a need  for a national website for all Bed Brigade Chapters to use. 
 See the this page for more information about Bed Brigade: https://www.bedbrigadecolumbus.org/about-us
 
 This is the current website that runs in Orchard Core:
 https://www.bedbrigadecolumbus.org/
 
-The national web site is being built in Blazor Server.  NET Core 7 is being used.
+The national web site is being built in Blazor Server.  NET Core 8 is being used.
 
 **Overall Direction**
 * The Bed Brigade national website will follow the Goodwill model where users will search a bed brigade near me by entering in a zip code