Skip to content

Commit 50ed879

Browse files
committed
prepare readme
1 parent e08eff7 commit 50ed879

File tree

5 files changed

+50
-2
lines changed

5 files changed

+50
-2
lines changed

.gitignore

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,2 +1,2 @@
11
*.db
2-
tls/
2+
tls/*.pem

README.md

Lines changed: 49 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,51 @@
1+
# Demo Go Application
2+
3+
This is the demo application which was developed throughout Alex Edwards [Let's Go](https://lets-go.alexedwards.net/) book with minor changes
4+
5+
- [sqlite3](https://github.com/mattn/go-sqlite3) instead of [mysql](https://github.com/golang/go/wiki/SQLDrivers)
6+
- database initialization using transactions
7+
- console interrupts and graceful shutdown support
8+
- [alice](https://github.com/justinas/alice) for middleware chains
9+
- [glide](https://github.com/Masterminds/glide) dependecies manager
10+
- additional checks for command-line parameters
11+
12+
## How to run
13+
114
```
15+
git clone https://github.com/avoidik/snippetbox
16+
cd snippetbox
217
go run $GOROOT/src/crypto/tls/generate_cert.go --rsa-bits=2048 --host=localhost
3-
```
18+
go run cmd/web/*
19+
```
20+
21+
## Useful links
22+
23+
Alex Edwards blog
24+
https://www.alexedwards.net/blog/
25+
26+
Go Basics
27+
http://openmymind.net/The-Little-Go-Book/
28+
29+
Pat - muxer
30+
https://github.com/bmizerany/pat
31+
32+
Bone - muxer
33+
https://github.com/go-zoo/bone
34+
35+
Gorilla - muxer
36+
https://github.com/gorilla/mux
37+
38+
Gorilla - sessions
39+
https://github.com/gorilla/sessions
40+
41+
SCS - sessions
42+
https://github.com/alexedwards/scs
43+
44+
Alice - middleware chaining
45+
https://github.com/justinas/alice
46+
47+
Nosurf - CSRF protection middleware
48+
https://github.com/justinas/nosurf
49+
50+
Gorilla - CSRF protection middleware
51+
https://github.com/gorilla/csrf
File renamed without changes.
File renamed without changes.

tls/.gitkeep

Whitespace-only changes.

0 commit comments

Comments
 (0)