Update

.github/actions/prepare/action.yml

@@ -0,0 +1,16 @@
+description: Prepares the repo for a typical CI job
+
+name: Prepare
+
+runs:
+  steps:
+    - uses: pnpm/[email protected]
+      with:
+        version: 8
+    - uses: actions/setup-node@v4
+      with:
+        node-version: '20.x'
+        cache: pnpm
+    - run: pnpm install
+      shell: bash
+  using: composite

.github/workflows/build.yml

@@ -0,0 +1,17 @@
+name: build-test
+
+on:
+  pull_request:
+  push:
+    branches:
+      - main
+
+jobs:
+  build:
+    runs-on: ubuntu-latest
+    steps:
+    - uses: actions/checkout@v4
+    - uses: ./.github/actions/prepare
+    - name: use pnpm to build site
+      run: |
+       pnpm build

README.md

@@ -1,9 +1,42 @@
-# Christmas Quotes 🎄
+# Christmas Quotes 🎄  
+
+![build-test](https://github.com/sanwebinfo/christmas-quotes/workflows/build-test/badge.svg)  
 
 A static site for sharing Christmas greeting quotes.  
 
 > Built using: Typescript, Bulma css and Vite  
 
+## Setup
+
+- Clone or Download the repo or Use this as Template While creating a New Repo on Github
+- install modules via npm or yarn or pnpm
+
+```sh
+pnpm install
+```
+
+- Development
+
+```sh
+pnpm dev
+```
+
+- Build the site
+
+```pnpm
+pnpm build
+```
+
+- Preview
+
+```sh
+pnpm preview
+```
+
+- Add Quotes to JSON database `/src/data/`
+- Modifications: `src/app.ts` and `src/index.html`
+- UI: `/src/styles/main.css`  
+
 ## Credits
 
 Christmas Quotes content Taken from random AI Models