diff options
| author | jackyzha0 <[email protected]> | 2020-05-10 17:10:15 -0700 |
|---|---|---|
| committer | jackyzha0 <[email protected]> | 2020-05-10 17:10:15 -0700 |
| commit | ccf722d9fa6f7b6a69d6ed977d325a909761e543 (patch) | |
| tree | f003d9541e21326e8ec7b89e4be78a54eb246f6b /README.md | |
| parent | Merge pull request #13 from jackyzha0/link-fe-be (diff) | |
| download | ctrl-v-ccf722d9fa6f7b6a69d6ed977d325a909761e543.tar.xz ctrl-v-ccf722d9fa6f7b6a69d6ed977d325a909761e543.zip | |
add readme instructions
Diffstat (limited to 'README.md')
| -rw-r--r-- | README.md | 20 |
1 files changed, 20 insertions, 0 deletions
diff --git a/README.md b/README.md new file mode 100644 index 0000000..220680b --- /dev/null +++ b/README.md @@ -0,0 +1,20 @@ +# ctrl-v source +### a modern, open-source pastebin with latex and markdown rendering support + +Frontend is in React and backend is in Go. + +## developing +#### Common +`make all` — starts React development server on `:3000` and backend on `:8080` + +#### Frontend +`make fe-run` — starts React development server on `:3000` +`make fe-build` — builds development release of frontend in `frontend/build` + +#### Backend +`make run` — starts backend on `:8080` +`make lint` — lints all Go files +`make docker-build` — builds Docker image of current backend +`make docker-run` — runs built Docker image on `:8080` +`make docker-all` — builds and runs built Docker image on `:8080` +`make docker-push` — pushes build Docker image to Dockerhub
\ No newline at end of file |