aboutsummaryrefslogtreecommitdiff
path: root/README.md
diff options
context:
space:
mode:
authorRyan Mehri <[email protected]>2020-05-25 23:09:20 -0600
committerGitHub <[email protected]>2020-05-25 23:09:20 -0600
commita104b512efb599d83c046dbea95379669b87bb8c (patch)
tree403e10b4ec1ebc78d7e6f16d1f50f299c973e242 /README.md
parentMerge pull request #32 from jackyzha0/latex-renderer (diff)
parentupdate makefile and readme (diff)
downloadctrl-v-a104b512efb599d83c046dbea95379669b87bb8c.tar.xz
ctrl-v-a104b512efb599d83c046dbea95379669b87bb8c.zip
Merge pull request #33 from jackyzha0/firebase
deploy
Diffstat (limited to 'README.md')
-rw-r--r--README.md12
1 files changed, 10 insertions, 2 deletions
diff --git a/README.md b/README.md
index 29d90e6..3bf9578 100644
--- a/README.md
+++ b/README.md
@@ -8,14 +8,20 @@ Frontend is in React and backend is in Go.
![View Paste (different theme)](https://user-images.githubusercontent.com/23178940/82101261-ea7a6b00-96c0-11ea-9cf1-9b81883ab9f5.png)
## developing
+when doing local backend development, make sure you change the backend address to be localhost. You can find this on Line 4 of `frontend/src/helpers/httpHelper.js`
+
#### Common
-`make all` &mdash; starts React development server on `:3000` and backend on `:8080`
+`make dev` &mdash; starts React development server on `:3000` and backend on `:8080`
+
+`make deploy` &mdash; deploys both frontend and backend
#### Frontend
`make fe-run` &mdash; starts React development server on `:3000`
`make fe-build` &mdash; builds development release of frontend in `frontend/build`
+`make firebase` &mdash; deploys dev release of frontend to Firebase. Live at `ctrl-v.app`
+
#### Backend
`make run` &mdash; starts backend on `:8080`
@@ -27,4 +33,6 @@ Frontend is in React and backend is in Go.
`make docker-all` &mdash; builds and runs built Docker image on `:8080`
-`make docker-push` &mdash; pushes build Docker image to Dockerhub \ No newline at end of file
+`make docker-push` &mdash; pushes build Docker image to Dockerhub
+
+`make gcr` &mdash; tags and pushes iamge to Google Container Registry for Cloud Run. Changes are live on `api.ctrl-v.app` \ No newline at end of file