From 616c18c5708d4a1c6942eb0ffd69a893427688db Mon Sep 17 00:00:00 2001 From: jackyzha0 Date: Mon, 1 Mar 2021 16:45:01 -0800 Subject: docs: remove deprecated manual scripts from readme and makefile --- Makefile | 15 ++++----------- README.md | 25 ++++++++----------------- 2 files changed, 12 insertions(+), 28 deletions(-) diff --git a/Makefile b/Makefile index c1a1e18..1763980 100644 --- a/Makefile +++ b/Makefile @@ -8,20 +8,13 @@ run: ## Start backend lint: ## Lint backend cd backend && golangci-lint run docker-build: ## Docker build backend - docker build -t jzhao2k19/ctrl-v:latest ./backend + docker build -t ctrl-v:latest ./backend docker-run: docker-build ## Start dockerized backend - docker run -p 8080:8080 jzhao2k19/ctrl-v:latest -gcr: docker-build ## Push to GCR - docker tag jzhao2k19/ctrl-v:latest gcr.io/ctrl-v-278404/backend && docker push gcr.io/ctrl-v-278404/backend -docker-push: ## Push to Docker Hub - docker push jzhao2k19/ctrl-v:latest + docker run -p 8080:8080 ctrl-v:latest + fe-run: ## Start Frontend cd frontend && yarn start fe-build: ## Productionize Frontend cd frontend && yarn build -fe-deploy: fe-build ## Deploy frontend to Firebase - cd frontend && firebase deploy dev: ## Start backend and frontend - make -j 2 run fe-run -deploy: ## Deploy backend and frontend - gcr && fe-deploy \ No newline at end of file + make -j 2 run fe-run \ No newline at end of file diff --git a/README.md b/README.md index d49a833..fe1b5f5 100644 --- a/README.md +++ b/README.md @@ -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. ![Go Paste Example](https://user-images.githubusercontent.com/23178940/83225601-06f0bb80-a135-11ea-9af2-9f2946459fe7.png) ![Markdown Rendering](https://user-images.githubusercontent.com/23178940/83225605-0821e880-a135-11ea-9efd-e7242ebde265.png) ![Showing off another theme!](https://user-images.githubusercontent.com/23178940/83225610-0a844280-a135-11ea-8c7c-4a0ecb13f379.png) ![Latex Rendering](https://user-images.githubusercontent.com/23178940/83225613-0c4e0600-a135-11ea-9f27-e5653cf9f343.png) -## 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 -- cgit v1.2.3