Alankrantas.github.io
Alan Wang's Github Pages Homepage
Built with Svelte, SvelteKit and Bootstrap. Has a basic but functional responsive web design. Has options to deploy as a Docker container (using serve as server) and supports DevContainer/Codespace.
Uses Github Action to deploy a production to Github Pages and enables dependabot for security updates. A file containing the current timestamp would be written into a static text file by Github Action so that it can be loaded and shown in the Svelte production.
This is technically an always-working-in-progress project and may be subjected to changes.
Notes for Development and Deployment
Prerequisites: Node.js, Git and Docker
Local Development
Install Yarn:
npm i -g yarn@latest
Windows users would need to grant permission for Yarn in PowerShell (as Administrator) with
Set-ExecutionPolicy -Scope CurrentUser -ExecutionPolicy Unrestricted.
Then
git clone https://github.com/alankrantas/alankrantas.github.io.git
cd alankrantas.github.io
yarn
Upgrade all packages:
yarn upgrade-all
After making changes:
yarn pull # resolve conflict if any
yarn format
yarn push
Or use
yarn committo pull, format then push.
List of Scripts
| Command | Description |
|---|---|
yarn upgrade-all |
Upgrade all NPM dependencies. |
yarn start |
Start a local dev server and open http://localhost:3000. |
yarn check |
Sync SvelteKit files. Run after installation and before build. |
yarn lint |
Lint files. |
yarn format |
Format and prettify files. |
yarn build |
Build a local production at ./build. |
yarn serve |
Serve the local production and open http://localhost:8080. |
yarn pull |
Pull commit histories from main branch. |
yarn push |
Push changes to main branch. |
yarn commit |
yarn pull + yarn format + yarn commit |
yarn docker-build |
Build a Docker container image |
yarn docker-run |
Run the Docker container and open http://localhost:8080. |
yarn docker-stop |
Stop the Docker container. |
yarn docker |
yarn docker-build + yarn docker-run |
(Re)create a New Project
a.k.a. Operation Clean Slate
Create whatever project I want locally, copy and paste the following files
.devcontainer/devcontainer.json.github/workflows/deploy.yml.github/dependabot.yml
Then
git init
git add .
git commit -m "first commit"
git remote add origin https://github.com/alankrantas/alankrantas.github.io.git
git push -u -f origin main
Links of Documentations
