Skip to content

Commit

Permalink
update README
Browse files Browse the repository at this point in the history
  • Loading branch information
AleksaC committed May 20, 2024
1 parent cf31332 commit 1cbddae
Show file tree
Hide file tree
Showing 2 changed files with 12 additions and 10 deletions.
1 change: 1 addition & 0 deletions .vale/Vocab/Technical/accept.txt
Original file line number Diff line number Diff line change
Expand Up @@ -45,3 +45,4 @@ pyc
(?i)html
[Vv]ite
Netlify
hugo
21 changes: 11 additions & 10 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,20 +3,21 @@
Code behind my personal website, [aleksac.me](https://aleksac.me).

[![pre-commit](https://github.com/AleksaC/aleksac.me/actions/workflows/pre-commit.yml/badge.svg)](https://github.com/AleksaC/aleksac.me/actions/workflows/pre-commit.yml)
[![deploy](https://github.com/AleksaC/aleksac.me/actions/workflows/deploy.yml/badge.svg)](https://github.com/AleksaC/aleksac.me/actions/workflows/deploy.yml)
[![lighthouse CI](https://github.com/AleksaC/aleksac.me/actions/workflows/lighthouse-ci.yml/badge.svg)](https://github.com/AleksaC/aleksac.me/actions/workflows/lighthouse-ci.yml)
[![Spellcheck](https://github.com/AleksaC/aleksac.me/actions/workflows/spellcheck.yml/badge.svg)](https://github.com/AleksaC/aleksac.me/actions/workflows/spellcheck.yml)
[![Deploy](https://github.com/AleksaC/aleksac.me/actions/workflows/deploy.yml/badge.svg)](https://github.com/AleksaC/aleksac.me/actions/workflows/deploy.yml)
[![Lighthouse CI](https://github.com/AleksaC/aleksac.me/actions/workflows/lighthouse-ci.yml/badge.svg)](https://github.com/AleksaC/aleksac.me/actions/workflows/lighthouse-ci.yml)

## About

The website is built using [next.js](https://github.com/vercel/next.js) with preact.
The website is built using [next.js](https://github.com/vercel/next.js) with [preact](https://preactjs.com/).
Since the website is simple and mostly static there were a lot of options to choose from.
I thought about using something like [astro](https://github.com/withastro/astro)
or [qwik](https://github.com/BuilderIO/qwik) or maybe even going with a static
site generator. However I chose next because for the following reasons:
or maybe even going with a traditional static site generator like [hugo](https://github.com/gohugoio/hugo).
However I chose next because for the following reasons:

- I already knew it well
- client-side routing and route prefetching out of the box
- negligible overhead in terms of bundle size (`<50kB` of js on most pages)
- negligible overhead in terms of bundle size (`<50kB` of gzipped js on most pages)
- there's a decent template to get started with
- would scale well to a more complicated website

Expand All @@ -27,7 +28,7 @@ intended to be reused by anyone other than me. However if you'd like to hack on
website or you think you can deal with my idiosyncrasies and would like to use
it as a base for your own website here's what you need:

- node 18
- node 18+
- pnpm

You'd probably want to fire up a dev server to get started. Here's how to do that:
Expand All @@ -44,9 +45,9 @@ and `pnpm run dev`.
### Infra

The website is deployed to cloudflare pages. It offers great performance as well
as availability across the globe for the low price of free. The deployment is not
done through cloudflare pages github integration. I'm using github actions instead.
This gets me:
as availability across the globe for the low price of free. Preview builds are also
nice. The deployment is not done through cloudflare pages github integration.
I'm using github actions instead. This gets me:

- faster builds
- easier orchestration of other github actions (e.g. lighthouse ci)
Expand Down

0 comments on commit 1cbddae

Please sign in to comment.