aslupin / workshop-deploy-svc

Repository for teaching `Deployment 101` topic.

Workshop for Deployment 101 🕯

Slide for workshop: Click here 📽

Prerequire ✨

• Heroku Account
• Git

Quickstart 🔥

1. Fork this repository. 💾
2. Enable GitHub Action feaure by go to Action tab in repository page that you forked. 🍌
3. Create Heroku Project on your account and note your app name for use in step (5). You have to create two project for frontend-service and backend-service. 📦
4. Get API-KEY from your account. Click https://dashboard.heroku.com/account and scroll to API Key then click Reveal button. 🔑
5. Create secret variable in forked repository by go to repository page>Setting>Secret then click New repository secret button. You have to add two secret variable (HEROKU_API_KEY and HEROKU_EMAIL). 🎉

Name	Description
HEROKU_API_KEY	Get by step (3)
HEROKU_EMAIL	Email for login heroku website

6. Run this command by replace [HEROKU_BACKEND_APP_NAME] and [HEROKU_FRONTEND_APP_NAME] in your own information. If you use Window OS then scroll to end of page for read alternative replace variable. 💣

make initial-app HEROKU_BACKEND_APP_NAME="[HEROKU_BACKEND_APP_NAME]" HEROKU_FRONTEND_APP_NAME="[HEROKU_FRONTEND_APP_NAME]"

7. Edit APIs JSON file (./backend/APIs.json) to your own information. 📝
8. Commit and push your code. 💊

git add .
git commit -m '[+] Setup Finish :tada:'
git push --set-upstream origin main

9. Deploy your backend service by merge code to release-backend branch. 🫖

git checkout -b release-backend
git pull origin main
git push --set-upstream origin release-backend

10. Deploy your frontend service by merge code to release-frontend branch. 🍙

git checkout -b release-frontend
git pull origin main
git push --set-upstream origin release-frontend

11. Enjoy your app 🚀

Troubleshooting 🐛

• If you use Window OS then you have to manual replace HEROKU_BACKEND_APP_NAME and HEROKU_FRONTEND_APP_NAME for each files instead make command on step (5).
  • ./.github/workflows/deploy-backend-heroku.yml
  • ./.github/workflows/deploy-frontend-heroku.yml
  • ./frontend/.env