Skip to content

chore: updated docs and links #458

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
hwakabh merged 2 commits into from
Dec 3, 2024
Merged

chore: updated docs and links #458

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
a3f93d5
docs: added local setup and motivations.
hwakabh Dec 3, 2024
21c8386
chore(fixture): updated links of works.
hwakabh Dec 3, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
27 changes: 22 additions & 5 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand All @@ -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
```
Comment on lines +17 to +26
Copy link

@coderabbitai coderabbitai bot Dec 3, 2024

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

💡 Codebase verification

🛠️ Refactor suggestion

Fix grammar and update Makefile command descriptions

The Makefile commands are correctly implemented and functional, but there are grammar issues in both the README and Makefile that should be fixed:

  • In README.md, apply the suggested grammar fixes:
-For bringing up all components required, [Makefile](./Makefile) has prepared. \
-Depending on your development requirements, there is a few options to use Makefile.
+For bringing up all required components, a [Makefile](./Makefile) has been prepared. \
+Depending on your development requirements, there are a few options to use the Makefile.
  • In Makefile, fix typos in target descriptions:
    • all: ## Start all componentes of application -> all: ## Start all components of application
    • prod: --check-docker ## Start emulate productin with build artifacts -> prod: --check-docker ## Start emulate production with build artifacts
🔗 Analysis chain

Fix grammar and verify Makefile commands

The Makefile instructions are helpful, but there's a grammar issue and we should verify the commands.

Fix the grammar in the introduction:

-For bringing up all components required, [Makefile](./Makefile) has prepared. \
-Depending on your development requirements, there is a few options to use Makefile.
+For bringing up all required components, a [Makefile](./Makefile) has been prepared. \
+Depending on your development requirements, there are a few options to use the Makefile.
🏁 Scripts executed

The following scripts were executed for the analysis:

Script:

#!/bin/bash
# Verify Makefile targets exist and are properly configured
grep -A 1 "^all:" Makefile
grep -A 1 "^prod:" Makefile

Length of output: 258

Script:

#!/bin/bash
# Let's verify the complete Makefile targets and their dependencies
cat Makefile

Length of output: 2860

🧰 Tools
🪛 LanguageTool

[uncategorized] ~18-~18: The verb “is” doesn’t seem to fit in this context, “are” is probably more formally correct.
Context: ...on your development requirements, there is a few options to use Makefile. ```shel...

(AI_HYDRA_LEO_CPT_IS_ARE)


## 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
6 changes: 3 additions & 3 deletions api-server/fixtures/payloads/works.json5
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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"
],
},
{
Expand Down
Loading