Skip to content
Open
Show file tree
Hide file tree
Changes from all commits
Commits
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
8 changes: 6 additions & 2 deletions .github/workflows/build.yml
Original file line number Diff line number Diff line change
Expand Up @@ -3,10 +3,14 @@ name: Build and Test
on:
push:
branches:
- 'main'
- main
paths-ignore:
- ./web
pull_request:
branches:
- 'main'
- main
paths-ignore:
- ./web

jobs:

Expand Down
27 changes: 27 additions & 0 deletions .github/workflows/gh-pages.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,27 @@
name: Update GitHub Pages

on:
push:
branches:
- main
paths:
- ./web

# temporary to test the live site
pull_request:

jobs:

update:
name: Update Github Pages
runs-on: ubuntu-latest
steps:
- uses: actions/checkout@v3

- name: Deploy
uses: peaceiris/actions-gh-pages@v3
with:
github_token: ${{ secrets.GITHUB_TOKEN }}
publish_dir: ./web
publish_branch: gh-pages
exclude_assets: .gitignore,tailwind.config.js,README.md,package.json,package-lock.json,node_modules
144 changes: 144 additions & 0 deletions web/.gitignore
Original file line number Diff line number Diff line change
@@ -0,0 +1,144 @@
# Created by https://www.toptal.com/developers/gitignore/api/node
# Edit at https://www.toptal.com/developers/gitignore?templates=node

### Node ###
# Logs
logs
*.log
npm-debug.log*
yarn-debug.log*
yarn-error.log*
lerna-debug.log*
.pnpm-debug.log*

# Diagnostic reports (https://nodejs.org/api/report.html)
report.[0-9]*.[0-9]*.[0-9]*.[0-9]*.json

# Runtime data
pids
*.pid
*.seed
*.pid.lock

# Directory for instrumented libs generated by jscoverage/JSCover
lib-cov

# Coverage directory used by tools like istanbul
coverage
*.lcov

# nyc test coverage
.nyc_output

# Grunt intermediate storage (https://gruntjs.com/creating-plugins#storing-task-files)
.grunt

# Bower dependency directory (https://bower.io/)
bower_components

# node-waf configuration
.lock-wscript

# Compiled binary addons (https://nodejs.org/api/addons.html)
build/Release

# Dependency directories
node_modules/
jspm_packages/

# Snowpack dependency directory (https://snowpack.dev/)
web_modules/

# TypeScript cache
*.tsbuildinfo

# Optional npm cache directory
.npm

# Optional eslint cache
.eslintcache

# Optional stylelint cache
.stylelintcache

# Microbundle cache
.rpt2_cache/
.rts2_cache_cjs/
.rts2_cache_es/
.rts2_cache_umd/

# Optional REPL history
.node_repl_history

# Output of 'npm pack'
*.tgz

# Yarn Integrity file
.yarn-integrity

# dotenv environment variable files
.env
.env.development.local
.env.test.local
.env.production.local
.env.local

# parcel-bundler cache (https://parceljs.org/)
.cache
.parcel-cache

# Next.js build output
.next
out

# Nuxt.js build / generate output
.nuxt
dist

# Gatsby files
.cache/
# Comment in the public line in if your project uses Gatsby and not Next.js
# https://nextjs.org/blog/next-9-1#public-directory-support
# public

# vuepress build output
.vuepress/dist

# vuepress v2.x temp and cache directory
.temp

# Docusaurus cache and generated files
.docusaurus

# Serverless directories
.serverless/

# FuseBox cache
.fusebox/

# DynamoDB Local files
.dynamodb/

# TernJS port file
.tern-port

# Stores VSCode versions used for testing VSCode extensions
.vscode-test

# yarn v2
.yarn/cache
.yarn/unplugged
.yarn/build-state.yml
.yarn/install-state.gz
.pnp.*

### Node Patch ###
# Serverless Webpack directories
.webpack/

# Optional stylelint cache

# SvelteKit build / generate output
.svelte-kit

# End of https://www.toptal.com/developers/gitignore/api/node
18 changes: 18 additions & 0 deletions web/README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,18 @@
# Web Preview

## Install dependencies

```powershell
cd ./web
npm install
```

## Running tailwindcss

```powershell
npx tailwindcss -i ./web/css/input.css -o ./web/css/output.css --watch
```

## Updating the github pages

There is a github action that will trigger on changes of this folder, it will push some files to the `gh-pages` branch.
51 changes: 51 additions & 0 deletions web/css/input.css
Original file line number Diff line number Diff line change
@@ -0,0 +1,51 @@
@tailwind base;
@tailwind components;
@tailwind utilities;

::selection {
@apply bg-slate-300;
}

#tutorial-area h1 {
@apply text-4xl font-normal text-slate-900 mb-3 mt-9;
}

#tutorial-area h2 {
@apply text-3xl font-normal text-slate-900 mb-2 mt-9;
}

#tutorial-area h3 {
@apply text-2xl font-semibold text-slate-900 mb-2 mt-9;
}

#tutorial-area h4 {
@apply text-xl font-semibold text-slate-900 mb-1 mt-7;
}

#tutorial-area p {
@apply text-slate-600
}

#tutorial-area pre {
@apply bg-slate-600 text-slate-100 rounded-lg p-3 overflow-auto scrollbar-thin my-2
}

#tutorial-area code {
@apply bg-slate-200 rounded-md px-1
}


pre,
.font-mono {
font-variant-ligatures: none;
}

button,
.btn {
@apply text-slate-900 hover:shadow-md shadow-black transition-colors text-center;
}

.grid-decoration {
background-image: linear-gradient(to bottom, rgb(255, 255, 255), rgba(255, 255, 255, 0)), url(../static/footer-texture.svg);
background-position: center;
}
Loading