Merge pull request #4 from onyas/docs

doc

Author: onyas

README.md

@@ -1,38 +1,27 @@
 ## Usage
-go run main.go -client -proxyServer https://yourProxyServer.com
-go run main.go -client -port 3000
-
-
-## Debug stage
-
-[Data Race Detector](https://go.dev/doc/articles/race_detector)
-```
-go run -race main.go
 
-go run -race main.go -client
+### Server side
+1. Fork and clone this repo
+2. Deploy to heroku
+    ```
+    //create app in heroku
+    heroku create
+    //deploy your app to heroku
+    git push heroku main
+    ```
+
+### Client side
 ```
-request http://localhost:8080/ through postman
+go run main.go -client -proxyServer yourProxyServer.herokuapp.com
 
-## Development with Heroku locally
-```
-//start server locally
-heroku local -f Procfile.local
-
-//start client locally
-go run main.go -client
+go run main.go -client -port 3000
 ```
 
-## Deploy to Heroku
+Now your local server is exposed to the internet, you could visit it by http://yourProxyServer.herokuapp.com
 
-```
-heroku login
-//create app in heroku
-heroku create
-//deploy your app to heroku
-git push heroku main
-//open you app in browser
-heroku open
 
-//check logs
-heroku logs --tail
-```
+## Useful docs
+- [Architecture of ggrok](./docs/architecture.md)
+- [How to run this project locally](./docs/run-locally.md)
+- [How to debug concurrent issues](./docs/debug.md)
+- [Useful Heroku command](./docs/heroku-command.md)

core/ggrok-client.go

@@ -24,7 +24,7 @@ func NewClient(s string, p int) *GGrokClient {
 	return &GGrokClient{RemoteServer: s, ProxyLocalPort: p}
 }
 
-func (ggclient *GGrokClient) Start() {
+func (ggclient *GGrokClient) Proxy() {
 	interrupt := make(chan os.Signal, 1)
 	signal.Notify(interrupt, os.Interrupt)
 

docs/architecture.md

@@ -0,0 +1,17 @@
+# Architecture
+
+This document describes the high-level architecture of ggrok. If you want to familiarize yourself with the code base, you are just in the right place!
+
+## Bird's Eye View
+
+```mermaid
+
+flowchart LR
+    PublicNet <--http--> ggrok-server
+    ggrok-server <-- websocket --> ggrok-client
+    PublicNet x--x LocalServer
+    LocalServer <--http--> ggrok-client
+
+```
+
+On the highest level, ggrok is a thing that exposes your local server to the internet, so that others can visit your local server easily.

docs/debug.md

@@ -0,0 +1,10 @@
+
+## Debug stage
+
+[Data Race Detector](https://go.dev/doc/articles/race_detector)
+```
+go run -race main.go
+
+go run -race main.go -client
+```
+request http://localhost:8080/ through postman

docs/heroku-command.md

@@ -0,0 +1,14 @@
+## Deploy to Heroku
+
+```
+heroku login
+//create app in heroku
+heroku create
+//deploy your app to heroku
+git push heroku main
+//open you app in browser
+heroku open
+
+//check logs
+heroku logs --tail
+```

docs/run-locally.md

@@ -0,0 +1,8 @@
+## Development with Heroku locally
+```
+//start server locally
+heroku local -f Procfile.local
+
+//start client locally
+go run main.go -client
+```

main.go

@@ -66,7 +66,7 @@ func startProxy(port int) {
 		defer close(done)
 
 		c := core.NewClient(proxyServer, port)
-		c.Start()
+		c.Proxy()
 	}()
 	<-done