Add CONTRIBUTING.md

andylibrian · Mar 21, 2021 · d767893 · d767893
1 parent 05c94c4
commit d767893
Show file tree

Hide file tree

Showing 2 changed files with 44 additions and 38 deletions.
diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md
@@ -0,0 +1,42 @@
+# Terjang
+
+## Development
+
+Prerequisites:
+- Go (tested version: 1.15)
+- Node (tested version: 14)
+
+Build backend:
+
+```bash
+go build -o ./bin/terjang ./cmd/terjang/
+```
+
+Run server:
+
+```bash
+./bin/terjang server
+```
+
+Run a worker on another terminal:
+
+```bash
+./bin/terjang worker
+```
+
+Install frontend:
+
+```bash
+cd web
+npm install
+```
+
+Run frontend:
+
+```bash
+./node_modules/.bin/vue-cli-service serve
+```
+
+Then open http://localhost:8080
+
+
diff --git a/README.md b/README.md
@@ -63,43 +63,7 @@ docker-compose up -d
 Then open [http://localhost:9009](http://localhost:9009)
 
 
-## Development
-
-Prerequisites:
-- Go (tested version: 1.15)
-- Node (tested version: 14)
-
-Build backend:
-
-```bash
-go build -o ./bin/terjang ./cmd/terjang/
-```
-
-Run server:
-
-```bash
-./bin/terjang server
-```
-
-Run a worker on another terminal:
-
-```bash
-./bin/terjang worker
-```
-
-Install frontend:
-
-```bash
-cd web
-npm install
-```
-
-Run frontend:
-
-```bash
-./node_modules/.bin/vue-cli-service serve
-```
-
-Then open http://localhost:8080
+## Contributing
 
+See [Contributing](CONTRIBUTING.md)