docs: improved readme

README.md

@@ -22,10 +22,20 @@ Currently I'm searching for an alternative for AWS S3 that I can use for free.
 ## Tech stacks
 
  * Go
- * 
+ * Node.js (for development on `client`)
+ * Postgres
+ * Redis
 
 That's it.
 
+## Development
+
+Two ways of doing this:
+  1. Install all the tech stack on your local machine
+  2. Use docker-compose
+
+See README files on each project directory for further instruction on how to run the development environment.
+
 ## License
 
 Copyright 2021-present Jokes Bapak2 API Contributors

api/README.md

@@ -2,7 +2,20 @@
 
 Still work in progress
 
-## 
+## Development
+
+```bash
+# Install modules
+$ go install
+# or
+$ go mod vendor
+
+# run the local server
+$ go run ./
+
+# build everything
+$ go build ./
+```
 
 ## Modules
 

api/go.mod

@@ -3,6 +3,6 @@ module github.com/aldy505/jokes-bapak2-api/api
 go 1.16
 
 require (
-	github.com/gin-gonic/gin v1.7.1 // indirect
+	github.com/gin-gonic/gin v1.7.1
-	github.com/rs/cors v1.7.0 // indirect
+	github.com/rs/cors v1.7.0
 )

api/main.go

@@ -1,6 +1,7 @@
 package main
 
 import (
+	"log"
 	"net/http"
 
 	"github.com/aldy505/jokes-bapak2-api/api/routes"
@@ -12,5 +13,6 @@ func main() {
 		Addr:    "localhost:3000",
 		Handler: routes,
 	}
+	log.Printf("[info] Server is running on http://localhost:3000")
 	server.ListenAndServe()
 }

client/README.md

@@ -1,2 +1,21 @@
-# Client
+# Jokes Bapak2 Client
 
+Still work in progress
+
+## Development
+
+Please install Yarn first by doing `npm i -g yarn`
+
+```bash
+# install dependency
+$ yarn install
+
+# run the local server
+$ yarn dev
+
+# build the package
+$ yarn build
+
+# preview it before deployment
+$ yarn preview
+```