From 5887f995b5edfb2c0df2f863f90ac0ff57bc948f Mon Sep 17 00:00:00 2001 From: Greg Finzer Date: Tue, 13 Aug 2024 11:33:52 -0400 Subject: [PATCH] Update documentation --- BlazorServer.md | 23 ----------------------- Documentation/Architecture.md | 3 +++ Documentation/Getting Started.md | 10 +++++++--- README.md | 4 ++-- 4 files changed, 12 insertions(+), 28 deletions(-) delete mode 100644 BlazorServer.md diff --git a/BlazorServer.md b/BlazorServer.md deleted file mode 100644 index 6c540207..00000000 --- a/BlazorServer.md +++ /dev/null @@ -1,23 +0,0 @@ -# Bed Brigade Server - -The app has been converted from Blazor Client Side to Blazor Server. - -At present, it is not running in Prerendered mode, but Server mode as we are using JsInterop. As soon as I can change to existing codes to work with Prerendering we'll switch. - -The only project dependancy is Client and Server to Shared. - -**Client Structure** - -* Components is where all client based components will live -* Data -* Services - Components inject services and services handle the work, e.g. Call the API Server. -* Pages - will use a qualifiing folder, e.g. Administration, Administration/Manage - - -**Server Structure** - -* Controllers - Client Services will call into the controller. Controllers will use a Server Service which will responed with a ServiceResponse. -* Services - Handles calls from a controller return a unit of work with a ServerResponse obj. - - -These are the minimum requirements. As additional dev requirements evole please update this document. \ No newline at end of file diff --git a/Documentation/Architecture.md b/Documentation/Architecture.md index 512b0b0b..65babaad 100644 --- a/Documentation/Architecture.md +++ b/Documentation/Architecture.md @@ -10,12 +10,15 @@ BedBrigadeNational\Documentation\Design
## Application Infrastructure Diagram +(This is out of date) ![Application Infrastructure Diagram](Design/Application%20Infrastructure%20Diagram.png)
## 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 index dfd96356..a0fb18df 100644 --- a/Documentation/Getting Started.md +++ b/Documentation/Getting Started.md @@ -12,7 +12,7 @@ https://www.syncfusion.com/sales/communitylicense * Visual Studio 2022 for the IDE. * SQL Server Express for local database development. * To run the project the ASP.NET Workload is required. -* .NET 7 SDK: https://dotnet.microsoft.com/ +* .NET 8 SDK: https://dotnet.microsoft.com/ * To run the NUnit tests, Resharper or NUnit Test Adapter 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 index 8be410b5..f0c09435 100644 --- 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 Greg Finzer 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