git/snippet-pastebin
1
0
Fork 0
mirror of https://github.com/johndoe6345789/snippet-pastebin.git synced 2026-04-24 13:34:55 +00:00
Code Issues Packages Projects Releases Wiki Activity

Address code review feedback: add VITE_BASE_PATH support and use placeholders in docs

Browse Source 
Co-authored-by: johndoe6345789 <224850594+johndoe6345789@users.noreply.github.com>
This commit is contained in:
copilot-swe-agent[bot]
2026-01-18 18:00:10 +00:00
parent 24ddec41dd
commit e9dbc31d6f
3 changed files with 15 additions and 11 deletions
Download Patch File Download Diff File Expand all files Collapse all files

1
.github/workflows/docker-publish.yml vendored
View File

@@ -62,3 +62,4 @@ jobs:
cache-to: type=gha,mode=max
build-args: |
VITE_FLASK_BACKEND_URL=${{ vars.VITE_FLASK_BACKEND_URL || '' }}
VITE_BASE_PATH=${{ vars.VITE_BASE_PATH || '/' }}

3
Dockerfile
View File

@@ -11,6 +11,9 @@ COPY . .
ARG VITE_FLASK_BACKEND_URL
ENV VITE_FLASK_BACKEND_URL=$VITE_FLASK_BACKEND_URL
ARG VITE_BASE_PATH
ENV VITE_BASE_PATH=$VITE_BASE_PATH
RUN npm run build
# Production stage

22
docs/CI-CD.md
View File

@@ -32,13 +32,13 @@ This workflow automatically builds a Docker image of the application and pushes
```bash
# Pull the latest image
docker pull ghcr.io/johndoe6345789/snippet-pastebin:latest
docker pull ghcr.io/<owner>/<repo>:latest
# Run the container
docker run -p 3000:3000 ghcr.io/johndoe6345789/snippet-pastebin:latest
docker run -p 3000:3000 ghcr.io/<owner>/<repo>:latest
# Pull a specific version
docker pull ghcr.io/johndoe6345789/snippet-pastebin:v1.0.0
docker pull ghcr.io/<owner>/<repo>:v1.0.0
```
**Making Images Public:**
@@ -67,12 +67,12 @@ This workflow builds the frontend application and deploys it to GitHub Pages.
2. **Configure Base Path:**
Set the `VITE_BASE_PATH` repository variable for proper asset loading:
- For deployment at `https://<username>.github.io/<repo>/`, set: `/snippet-pastebin/`
- For deployment at `https://<username>.github.io/<repo>/`, set: `/<repo>/`
- For custom domain or root deployment, set: `/`
Go to Settings → Secrets and variables → Actions → Variables → New repository variable
- Name: `VITE_BASE_PATH`
- Value: `/snippet-pastebin/` (or your repository name)
- Value: `/<repo>/` (or your repository name)
3. **Optional Configuration:**
- Set `VITE_FLASK_BACKEND_URL` as a repository variable if you want to connect to a backend
@@ -90,7 +90,7 @@ After the workflow runs successfully, your site will be available at:
Set these variables in your repository settings (Settings → Secrets and variables → Actions → Variables):
- `VITE_BASE_PATH` (recommended for GitHub Pages): Base path for the application
- Example: `/snippet-pastebin/` for `username.github.io/snippet-pastebin/`
- Example: `/<repo>/` for `username.github.io/<repo>/`
- Use `/` for custom domains or root deployment
- `VITE_FLASK_BACKEND_URL` (optional): URL of your Flask backend API
- Example: `https://api.example.com`
@@ -165,8 +165,8 @@ To test the workflows locally, you can:
1. **Build the Docker image:**
```bash
docker build -t snippet-pastebin .
docker run -p 3000:3000 snippet-pastebin
docker build -t <repo> .
docker run -p 3000:3000 <repo>
```
2. **Build for GitHub Pages:**
@@ -179,11 +179,11 @@ To test the workflows locally, you can:
## Workflow Status Badges
Add these badges to your README.md:
Add these badges to your README.md (replace `<owner>` and `<repo>` with your values):
```markdown
[![Docker Build](https://github.com/johndoe6345789/snippet-pastebin/actions/workflows/docker-publish.yml/badge.svg)](https://github.com/johndoe6345789/snippet-pastebin/actions/workflows/docker-publish.yml)
[![Deploy to Pages](https://github.com/johndoe6345789/snippet-pastebin/actions/workflows/deploy-pages.yml/badge.svg)](https://github.com/johndoe6345789/snippet-pastebin/actions/workflows/deploy-pages.yml)
[![Docker Build](https://github.com/<owner>/<repo>/actions/workflows/docker-publish.yml/badge.svg)](https://github.com/<owner>/<repo>/actions/workflows/docker-publish.yml)
[![Deploy to Pages](https://github.com/<owner>/<repo>/actions/workflows/deploy-pages.yml/badge.svg)](https://github.com/<owner>/<repo>/actions/workflows/deploy-pages.yml)
```
## Further Customization