aboutsummaryrefslogtreecommitdiff
path: root/README.md
blob: 5afa77144813e7f1f4e0a51f347ae793c2dabcde (plain) (blame)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
# alexscerba.com

## Overview

* Developed in Go
* Use of builtin text/template system
* [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
    +-- master.tmpl.html
    +-- index.tmpl.html
    \-- projects
        +-- project1.tmpl.html
        +-- project2.tmpl.html
        +-- ...
\-- static
    +-- Resume_Scerba.pdf
    \-- media
        \-- projectN
            \-- hq-main
                +-- img1.jpg
                +-- img2.jpg
                +-- ...
            \-- sq-main
                +-- img1_1000.jpg
                +-- img2_1000.jpg
                +-- ...
            \-- lowres-main
                +-- img1_400.jpg
                +-- img2_400.jpg
                +-- ...
            \-- sq-thumb
                +-- img1_600.jpg
                +-- img2_600.jpg
                +-- ...
            \-- lowres-thumb
                +-- img1_200.jpg
                +-- img2_200.jpg
                +-- ...
    \-- assets
        \-- fonts
            \-- <font-folder>
        +-- style.css
        +-- favicon.ico
        +-- logo.svg
        +-- profile-pic.jpg
        +-- sitemap.xml
```