diff options
Diffstat (limited to 'README.md')
| -rw-r--r-- | README.md | 25 |
1 files changed, 8 insertions, 17 deletions
@@ -1,37 +1,28 @@ -# ctrl-v source -### a modern, open-source pastebin with latex and markdown rendering support - -Frontend is in React and backend is in Go. +# ctrl-v +### A modern, open-source pastebin with latex and markdown rendering support +Frontend is in React and backend is in Go. Deployed via Firebase Hosting and Google Cloud Run.     -## developing +## 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 +### Common `make dev` — starts React development server on `:3000` and backend on `:8080` -`make deploy` — deploys both frontend and backend - -#### Frontend +### Frontend `make fe-run` — starts React development server on `:3000` `make fe-build` — builds development release of frontend in `frontend/build` -`make fe-deploy` — deploys dev release of frontend to Firebase. Live at `ctrl-v.app` - -#### Backend +### 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-push` — pushes build Docker image to Dockerhub - -`make gcr` — 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 +`make docker-run` — runs built Docker image on `:8080`
\ No newline at end of file |