Skip to content

Commit aba008e

Browse files
Add explanation of the app
1 parent 012e3e0 commit aba008e

File tree

1 file changed

+20
-0
lines changed

1 file changed

+20
-0
lines changed

README.md

+20
Original file line numberDiff line numberDiff line change
@@ -14,6 +14,26 @@ capabilities.
1414
- Install Go https://go.dev/doc/install
1515
- Run `make` to run the application
1616

17+
## Application
1718

19+
The application is a todo list application.
1820

21+
The application is a Go application with a simple REST API and a simple
22+
frontend in JavaScript.
23+
24+
The frontend is in the `internal/js` folder and is a simple single page
25+
application that allows you to add todos to the todo list. The JavaScript
26+
application is delivered with a Golang embedded filesystem.
27+
28+
The frontend uses [Alpine.js](https://alpinejs.dev/) as the JavaScript framework.
29+
30+
The Go backend is in the `internal/todo` folder and contains the following:
31+
32+
- `db`: The database models and the database access functions.
33+
- `usecase`: The use cases of the application.
34+
- `web`: The HTTP handlers of the application.
35+
36+
The database is SQLite with [GORM](https://gorm.io/) as the database access library.
37+
38+
The *_module.go files are the entry points for each module.
1939

0 commit comments

Comments
 (0)