aboutsummaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorAlex Scerba <alex@scerba.org>2024-03-13 11:10:58 -0400
committerAlex Scerba <alex@scerba.org>2024-10-29 13:20:00 -0400
commit1b75b157da786ccd1c07f90ee9dd43b13aba47bb (patch)
tree33e2f049244493b7ccbea9c24049e4db45b86e53
parentf7acdf9c8faeb3d0a0393f0e8744cfbcfd3e303a (diff)
Add structure planning
-rw-r--r--README.md37
1 files changed, 36 insertions, 1 deletions
diff --git a/README.md b/README.md
index 1eebd2f..f8926aa 100644
--- a/README.md
+++ b/README.md
@@ -4,4 +4,39 @@
* Developed in Go
* Use of builtin text/template system
-* [See the site in action](https://alexscerba.com/) \ No newline at end of file
+* [See the site in action](https://alexscerba.com/)
+
+## Structure Planning
+
+### Templates
+* base - _useful constants: head, header/nav, footer_
+* index - _homepage: displays all projects and short 'about' in TBD layout_
+* projectN - _individual project pages_
+
+### Go Structure
+* main.go - _high level redirects, handle function and http server calls_
+* middle.go - _gzip + any other intermediary_
+* handle.go - _handle function definitions_
+* load.go - _reads and loads post into a struct + other relevant functions_
+* render.go - _combines templates and renders the final output_
+* errors.go - _functions for error handling and logging_
+
+### Folder Structure
+```
+\-- cmd/http
+ +-- main.go
+ +-- middle.go
+ +-- handle.go
+ +-- load.go
+ +-- render.go
+ +-- errors.go
+\-- html
+\-- static
+ \-- media
+ \-- fonts
+ \-- <font-folder>
+ +-- style.css
+ +-- favicon.ico
+ +-- logo.svg
+ +-- sitemap.xml
+``` \ No newline at end of file