Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Update Developer Documentation #313

Merged
merged 1 commit into from
Aug 14, 2024
Merged

Update Developer Documentation #313

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 0 additions & 2 deletions Documentation/Architecture.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -15,9 +15,7 @@ BedBrigadeNational\Documentation\Design
<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)
Binary file modified Documentation/Design/EntityRelationshipDiagram.png
View file
Open in desktop
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
4 changes: 3 additions & 1 deletion Documentation/Developer Notes.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1 +1,3 @@
The compilerconfig.json allows the theme.scss to be compiled into theme.css
# Developer Notes

* The compilerconfig.json allows the theme.scss to be compiled into theme.css
15 changes: 15 additions & 0 deletions Documentation/Developer Overview.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,15 @@
# Developer Overview

## Solution Overview
* The **BedBrigade.Client** project is a Blazor Web App that in Server Interactive Render Mode.
* The **BedBrigade.Common** project contains the Models and shared business logic.
* The **BedBrigade.Data** project uses Entity Framework for CRUD operations.
* The **BedBrigade.Tests** project contains unit tests and code quality tests.

## BedBrigade.Client
* This project has both client facing and administration pages. It has a custom content management system (CMS).
* MainLayout.razor is used for client facing pages. It displays a Header and Footer using the respective Header.razor and Footer.razor components.
* AdminLayout.razor is used after logging in. The only difference between the MainLayout and AdminLayout is the AdminLayout does not have a footer.
* CheckAuthorization.razor is used in the Routes.razor to display a message if they are not authorized.
* Index.razor displays all of the static content for all locations using the MyBody component.
* Because there is so much startup code. The program.cs calls off to StartupLogic.cs which handles everything. The StartupLogic.cs creates and seeds the database if it does not exist.
2 changes: 2 additions & 0 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -38,6 +38,8 @@ Current Website running in Orchard CMS: https://www.bedbrigadecolumbus.org/

* [Architecture](Documentation/Architecture.md)
* [Getting Started](Documentation/Getting%20Started.md)
* [Developer Overview](Documentation/Developer%20Overview.md)
* [Developer Notes](Documentation/Developer%20Notes.md)
* [Entity Framework](Documentation/Entity%20Framework.md)
* <a href="https://github.com/GregFinzer/BedBrigadeNational/raw/main/Documentation/Design/Estimates.xlsx" target="_blank">Estimates</a>
* [Implementation Plan](Documentation/Implementation%20Plan.md)
Expand Down
Loading