Skip to content

Commit d450149

Browse files
committed
Deploy to GitHub Pages, add README and LICENSE
1 parent a1c1369 commit d450149

4 files changed

Lines changed: 104 additions & 0 deletions

File tree

.github/workflows/deploy.yml

Lines changed: 43 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,43 @@
1+
name: Build and Deploy
2+
3+
on:
4+
push:
5+
branches: ['main']
6+
workflow_dispatch:
7+
8+
permissions:
9+
contents: read
10+
pages: write
11+
id-token: write
12+
13+
concurrency:
14+
group: 'pages'
15+
cancel-in-progress: true
16+
17+
jobs:
18+
deploy:
19+
environment:
20+
name: github-pages
21+
url: ${{ steps.deployment.outputs.page_url }}
22+
runs-on: ubuntu-latest
23+
steps:
24+
- name: Checkout
25+
uses: actions/checkout@v5
26+
- name: Set up Node
27+
uses: actions/setup-node@v5
28+
with:
29+
node-version: lts/*
30+
cache: 'npm'
31+
- name: Install dependencies
32+
run: npm ci
33+
- name: Build
34+
run: npm run build
35+
- name: Setup Pages
36+
uses: actions/configure-pages@v5
37+
- name: Upload artifact
38+
uses: actions/upload-pages-artifact@v4
39+
with:
40+
path: './dist'
41+
- name: Deploy to GitHub Pages
42+
id: deployment
43+
uses: actions/deploy-pages@v4

LICENSE

Lines changed: 21 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,21 @@
1+
The MIT License (MIT)
2+
3+
Copyright © 2025 Ieben Smessaert
4+
5+
Permission is hereby granted, free of charge, to any person obtaining a copy
6+
of this software and associated documentation files (the "Software"), to deal
7+
in the Software without restriction, including without limitation the rights
8+
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
9+
copies of the Software, and to permit persons to whom the Software is
10+
furnished to do so, subject to the following conditions:
11+
12+
The above copyright notice and this permission notice shall be included in
13+
all copies or substantial portions of the Software.
14+
15+
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
16+
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
17+
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
18+
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
19+
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
20+
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
21+
THE SOFTWARE.

README.md

Lines changed: 34 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,34 @@
1+
# WebPoster
2+
3+
Kick-start the creation of your RDFa-annotated Web poster in HTML.
4+
5+
## Getting Started
6+
7+
Create a repository using this template and follow the instructions below.
8+
9+
Install the dependencies and run the development server:
10+
11+
```bash
12+
npm install
13+
npm run dev
14+
```
15+
16+
Edit `index.html` to customize your poster content.
17+
- You can configure your theme colors and font in `css/style.scss`
18+
- You can choose different section layouts by using the grid-column and grid-row CSS properties.
19+
- You can add icons from [Font Awesome](https://fontawesome.com/icons) by adding the relevant classes to the `<i>` elements.
20+
- You can add images by placing them in the `images` folder and referencing them in your HTML.
21+
22+
## Deployment
23+
24+
You can deploy your poster to GitHub Pages or any static site hosting service.
25+
26+
The template is configured to deploy to GitHub Pages.
27+
Make sure to update the `base` field in `vite.config.js` to match your repository name.
28+
29+
You can manually build and test the production version with:
30+
31+
```bash
32+
npm run build
33+
npm run serve
34+
```

vite.config.js

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,6 @@
1+
import { defineConfig } from 'vite'
2+
3+
export default defineConfig({
4+
// set base in production
5+
base: process.env.NODE_ENV === 'production' ? '/WebPoster/' : '/',
6+
})

0 commit comments

Comments
 (0)