From a3f93d52551cd0ae48bea31e86e9ca80f173bb75 Mon Sep 17 00:00:00 2001 From: hwakabh Date: Tue, 3 Dec 2024 11:42:21 +0900 Subject: [PATCH 1/2] docs: added local setup and motivations. --- README.md | 27 ++++++++++++++++++++++----- 1 file changed, 22 insertions(+), 5 deletions(-) diff --git a/README.md b/README.md index bfdde8b9..22d58dd6 100644 --- a/README.md +++ b/README.md @@ -2,7 +2,7 @@ [![Backend CI](https://github.com/hwakabh/hwakabh.github.io/actions/workflows/backend.yaml/badge.svg?branch=main)](https://github.com/hwakabh/hwakabh.github.io/actions/workflows/backend.yaml) [![Frontend CI](https://github.com/hwakabh/hwakabh.github.io/actions/workflows/frontend.yaml/badge.svg?branch=main)](https://github.com/hwakabh/hwakabh.github.io/actions/workflows/frontend.yaml) -Personal Portfolio Page +Personal Portfolio Page with GitHub fullstack ## Architecture Based on JavaScript/TypeScript and fullstack features of GitHub @@ -14,10 +14,27 @@ Backend: Express For more detailed design, including API design or URL patterns, will be noted in repository [Wiki](https://github.com/hwakabh/hwakabh.github.io/wiki). ## Run applications locally -TBD /w compose.yaml or Makefile +For bringing up all components required, [Makefile](./Makefile) has prepared. \ +Depending on your development requirements, there is a few options to use Makefile. -## Directory Layouts -TBD +```shell +# Starting Frontend and Backend directly on your machine +% make all + +# Build Frontend code bases and pulling containerized Backend images for UI +% make prod +``` ## Motivations -TBD (Personal workout and sandboxes) +Leveraging fullstack features of GitHub such as: +- GitHub Actions +- GHCR (GitHub Container Registry) +- Release automation +- Code Owners and scaffolded policy files (contributing/Security policies or Code of Conduct) +- Dependabot +- Issue/PR templates + +Personal workouts with JavaScript ecosystem +- Vue.js for Frontend +- Express.js for Backend (stateless) +- generic Node.js project for Swagger documentations From 21c8386db94e68672ac726004e232fc2f963586b Mon Sep 17 00:00:00 2001 From: hwakabh Date: Tue, 3 Dec 2024 11:44:05 +0900 Subject: [PATCH 2/2] chore(fixture): updated links of works. --- api-server/fixtures/payloads/works.json5 | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) diff --git a/api-server/fixtures/payloads/works.json5 b/api-server/fixtures/payloads/works.json5 index 457e9200..45c3b563 100644 --- a/api-server/fixtures/payloads/works.json5 +++ b/api-server/fixtures/payloads/works.json5 @@ -3,14 +3,14 @@ "list": [ { "title": "Bennu Official Homepage", - "url": "https://bennu-official.page/home/", + "url": "https://www.bennu-official.page", "gitHubRepoUrl": "https://github.com/hwakabh/bennu-official.page", "descriptions": "Official Homepage of Bennu", "techStacks": [ "Python", "Django", - "Kubernetes (Google Kubernetes Engine)", - "Cloud Native Builpacks (Google Cloud Buildpacks)", + "Railway", + "Nixpacks" ], }, {