Skip to content

Commit c8de7fc

Browse files
author
meowabyte
committed
Init
0 parents  commit c8de7fc

35 files changed

+1441
-0
lines changed

.github/workflows/export.yml

Lines changed: 63 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,63 @@
1+
name: Build and Deploy
2+
on:
3+
push:
4+
branches: [ "main" ]
5+
paths:
6+
- "src/**/*"
7+
- "*.{js,json,ts}"
8+
- ".github/workflows/export.yml"
9+
workflow_dispatch:
10+
11+
permissions:
12+
contents: read
13+
pages: write
14+
id-token: write
15+
16+
concurrency:
17+
group: build-and-deploy
18+
cancel-in-progress: true
19+
20+
jobs:
21+
build:
22+
runs-on: ubuntu-latest
23+
steps:
24+
- name: Checkout repository
25+
uses: actions/checkout@v4
26+
27+
- name: Setup Bun
28+
uses: oven-sh/setup-bun@v2
29+
with:
30+
bun-version: latest
31+
32+
- name: Cache dependencies
33+
uses: actions/cache@v4
34+
with:
35+
path: ~/.bun/install/cache
36+
key: "${{ runner.os }}-bun-${{ hashFiles('**/bun.lock', '**/package.json') }}"
37+
restore-keys: |
38+
${{ runner.os }}-bun-
39+
40+
- name: Install dependencies
41+
run: bun install --frozen-lockfile
42+
43+
- name: Build project
44+
run: bun run build
45+
46+
- name: Setup Pages
47+
uses: actions/configure-pages@v5
48+
49+
- name: Upload artifact
50+
uses: actions/upload-pages-artifact@v3
51+
with:
52+
path: ./dist
53+
54+
deploy:
55+
needs: build
56+
runs-on: ubuntu-latest
57+
environment:
58+
name: github-pages
59+
url: ${{ steps.deployment.outputs.page_url }}
60+
steps:
61+
- name: Deploy to GitHub Pages
62+
id: deployment
63+
uses: actions/deploy-pages@v4

.gitignore

Lines changed: 24 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,24 @@
1+
# Logs
2+
logs
3+
*.log
4+
npm-debug.log*
5+
yarn-debug.log*
6+
yarn-error.log*
7+
pnpm-debug.log*
8+
lerna-debug.log*
9+
10+
node_modules
11+
dist
12+
dist-ssr
13+
*.local
14+
15+
# Editor directories and files
16+
.vscode/*
17+
!.vscode/extensions.json
18+
.idea
19+
.DS_Store
20+
*.suo
21+
*.ntvs*
22+
*.njsproj
23+
*.sln
24+
*.sw?

.vscode/extensions.json

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,6 @@
1+
{
2+
"recommendations": [
3+
"yoavbls.pretty-ts-errors",
4+
"bradlc.vscode-tailwindcss"
5+
]
6+
}

LICENSE

Lines changed: 21 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,21 @@
1+
MIT License
2+
3+
Copyright (c) 2025 meowabyte
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 all
13+
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 THE
21+
SOFTWARE.

README.md

Lines changed: 41 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,41 @@
1+
# meowpa.ws
2+
[meowpa.ws](https://meowpa.ws) is my personal page written in [Vite](https://vite.dev/).
3+
4+
It is written in [Preact](https://preactjs.com) (originally in React) to keep sizes of files as low as possible while not sactificing it's quality from the original. It also uses various optimization techniques such as tree-shaking, dynamic imports, code splitting, minifing or prerendering (via [preact-iso](https://github.com/preactjs/preact-iso/) and it's `prerender` function) to make the site as performant as possible.
5+
6+
**It includes plugins such as:**
7+
- [TailwindCSS](https://tailwindcss.com/)
8+
- [Vite-Image-Optimizer](https://github.com/FatehAK/vite-plugin-image-optimizer)
9+
- [Vite-Bundle-Analyzer](https://github.com/nonzzz/vite-bundle-analyzer)
10+
11+
It also includes [my own plugins](/plugins/) for purposes like cleaning unused/build related files from `dist` that cannot be removed in normal way.
12+
13+
## Development
14+
In this example I'm gonna use [bun](https://bun.sh/) as a package manager and runtime as well as and [git](https://git-scm.com/) for cloning the repo.
15+
```bash
16+
# Clone repo
17+
$ git clone https://github.com/meowabyte/meowabyte.github.io
18+
19+
# Navigate to the project directory
20+
$ cd "meowabyte.github.io"
21+
22+
# Install requirements
23+
$ bun install
24+
25+
# Run development server
26+
$ bun dev
27+
```
28+
If you made everything correctly, your terminal should show current url on which the page is being displayed.
29+
30+
## Building
31+
Considering you've followed [steps above](#development) you probably wonder how to build it? It's quite easy.
32+
```bash
33+
# Build the project
34+
$ bun build
35+
```
36+
And to see final results (where unlike with `bun dev` you'd have dev enviornment - with `bun build` you have already optimized files) just run `bun preview` to run built files in Vite's official production environment. (You can also use [serve](https://www.npmjs.com/package/serve) for more raw experience - `bunx serve dist` - which will use port `3000`)
37+
38+
39+
40+
## Licensing
41+
As stated in [LICENSE file](/LICENSE), you can edit, modify or publish the code I included in here in any way as long as you provide any credit to it.

0 commit comments

Comments
 (0)