aboutsummaryrefslogtreecommitdiff
path: root/README.md
diff options
context:
space:
mode:
Diffstat (limited to 'README.md')
-rw-r--r--README.md21
1 files changed, 21 insertions, 0 deletions
diff --git a/README.md b/README.md
new file mode 100644
index 0000000..4fe60c2
--- /dev/null
+++ b/README.md
@@ -0,0 +1,21 @@
+This codebase was created to demonstrate a fully fledged fullstack application built with
+
+ - [Fiber v2](https://github.com/gofiber/fiber/tree/v2.52.6) an Express inspired web framework for Go
+ - [HTMX](https://htmx.org/) to connect the frontend (html + js) with the backend
+ - [Slug](https://github.com/gosimple/slug) for user friendly URLS
+ - [OR Mapper gorm](gorm.io/gorm) and a [Go native driver for GORM to sqlite](https://github.com/glebarez/sqlite)
+ - and [other packages](go.mod)
+
+## Project Overview
+
+"Projecty" is a social project development site for DIY enthusiaists and product builders.
+
+# Installation
+```
+1. clone this repository
+2. run: go get
+3. this project is using sqlite and its already seeded, look at database.sqlite
+4. run: go run main.go
+6. use test@email.com|secret for logging in
+ 6.1. or can register from the web
+```