From 708aadcb5a0cac56480c071a058205db4e66498b Mon Sep 17 00:00:00 2001
From: itsscb <dev@itsscb.de>
Date: Sun, 1 Oct 2023 15:26:32 +0200
Subject: [PATCH] Add README.md (#53)

---
 Makefile  |  6 ++++-
 README.md | 65 +++++++++++++++++++++++++++++++++++++++++++++++++++++++
 2 files changed, 70 insertions(+), 1 deletion(-)
 create mode 100644 README.md

diff --git a/Makefile b/Makefile
index a53f337..6ae3fbc 100644
--- a/Makefile
+++ b/Makefile
@@ -1,5 +1,9 @@
 DB_URL=postgresql://root:secret@localhost:5432/df?sslmode=disable
 
+
+initialize:
+	go mod tidy && docker run --name postgres -p 5432:5432 -e POSTGRES_USER=root -e POSTGRES_PASSWORD=secret -d postgres:15-alpine && sleep 5 && make network && make createdb && make migrateup && make test
+
 network:
 	docker network create df-network
 
@@ -39,4 +43,4 @@ server:
 mock:
 	mockgen -package mockdb -destination db/mock/store.go github.com/itsscb/df/db/sqlc Store
 
-.PHONY: postgres migratenew createdb dropdb migrateup migratedown sqlc sqlcinit test server
+.PHONY: postgres migratenew createdb dropdb migrateup migratedown sqlc sqlcinit test server, initialize
diff --git a/README.md b/README.md
new file mode 100644
index 0000000..cf7884b
--- /dev/null
+++ b/README.md
@@ -0,0 +1,65 @@
+# df
+
+To first run the application in your local environment you can use ```make initialize``` or run the commands listed in ```Makefile``` unter `initialize` ***manually*** with your terminal in the repository directory.
+
+# Prerequisites
+
+To create a local development environment you need some tools.
+
+## Backend
+### Basics
+
+You need the basics if you just want to start a test environment to test the application.
+
+#### Optional but recommended
+If you wish to use the `Makefile` you need [`make`](https://www.gnu.org/software/make/) which should be available for most linux systems. 
+
+However if you are on *Windows* you could use [`GnuWin32.Make`](https://gnuwin32.sourceforge.net/install.html) which can be installed on *Windows 11* using:
+
+```winget install GnuWin32.Make```
+
+#### Database
+
+To work with the database you need the following tools.
+
+##### Container software
+
+You can use either `docker` or `podman`. But the `Makefile` uses the `docker` command. 
+
+If you wish to use `podman` you can create a `symlink` to make it work.
+On `fedora` it works like this:
+
+```
+# Rename the docker binary:
+sudo mv /usr/bin/docker /usr/bin/docker_bkp
+
+# Create a symlink
+sudo ln -s /usr/bin/podman /usr/bin/docker
+```
+
+##### golang-migrate
+
+`golang-migrate` makes db schema initialization and updates easy.
+
+You can install it as described [here](https://github.com/golang-migrate/migrate/tree/master/cmd/migrate).
+
+Furthermore the binary should be in your `PATH` environment variable.
+
+The two most used commands are in the `Makefile`:
+- migrateup
+- migratedown
+
+#### Server
+
+To run the server you need `go` installed. [See here for instructions](https://go.dev/doc/install)
+
+### Developing
+
+Should you want to make changes you need further tools.
+
+- [sqlc](https://docs.sqlc.dev/en/stable/overview/install.html): For generating code from `postgres` queries
+- [gomock](https://github.com/uber-go/mock): For generating a mock database for testing
+
+## Frontend
+
+***This section will be added as soon as we begin with the development of the frontend***
\ No newline at end of file