Skip to content

Latest updates #24

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 10 commits into from
Jan 8, 2025
Merged
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
1 change: 1 addition & 0 deletions .nvmrc
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
v20
6 changes: 5 additions & 1 deletion .prettierignore
Original file line number Diff line number Diff line change
@@ -1,3 +1,7 @@
dist
out
node_modules
node_modules
assets/bundle
assets/favicon-opt
assets/media-opt
assets/refs
9 changes: 8 additions & 1 deletion .vscode/extensions.json
Original file line number Diff line number Diff line change
@@ -1,3 +1,10 @@
{
"recommendations": ["esbenp.prettier-vscode", "dbaeumer.vscode-eslint"]
"recommendations": [
"dbaeumer.vscode-eslint",
"amodio.tsl-problem-matcher",
"eamodio.gitlens",
"esbenp.prettier-vscode",
"connor4312.css-theme-completions",
"runem.lit-plugin"
]
}
2 changes: 1 addition & 1 deletion .vscode/tasks.json
Original file line number Diff line number Diff line change
Expand Up @@ -13,7 +13,7 @@
"script": "clean",
"problemMatcher": [],
"label": "Run clean",
"detail": "rimraf assets/bundle"
"detail": "npx rimraf assets/bundle"
}
]
}
Binary file modified .yarn/install-state.gz
Binary file not shown.
62 changes: 62 additions & 0 deletions CONRTIBUTING.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,62 @@
# Contributing

> [!WARNING]
> This is purely a testbed for trying out ideas and experimenting with newer APIs and techniques. Consider everything experimental and not recommended for production use.

## Getting Started

### Prerequisites

- [Git](https://git-scm.com/), `>= 2.7.2`
- [NodeJS](https://nodejs.org/), `>= v20.11.1`
- [Yarn](https://yarnpkg.com/), `4.1.0` (this repository does **not** commit the cache)

For those using [nvm](https://github.com/nvm-sh/nvm), simply run the following command to install the required version of NodeJS:

```bash
nvm use
```

### Dependencies

From a terminal, where you have cloned the repository, execute the following command to install the required dependencies:

```bash
yarn install
```

## Developing

Running locally (defaults to `http://127.0.0.1:5500`)

```bash
yarn start
```

Check and fix code style

```bash
yarn lint
```

Optimize images from `assets/media` and `assets/favicon` and saves the optimized versions to `assets/media-opt` and `assets/favicon-opt` respectively:

```bash
yarn images
```

## Release

Build and bundle files in `src` to `assets/bundle`

```bash
yarn build
```

To analyze the bundle

```bash
yarn analyze
```

The built files from `assets/*` plus `index.html` can be served from any static file server. GitHub Pages are used for this repository and deployed to https://d13.github.io/.
34 changes: 4 additions & 30 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,35 +1,9 @@
# d13.github.io

My personal website and general dumping ground to try out my ideas.

## Local Setup

You will need node.js installed to run this locally and build the files.

To get started:
- From the terminal, browse to the project's root folder
- Run `npm install`


## Development gulp task

Run `gulp dev`
> **WARNING**: This is purely a testbed for trying out ideas and experimenting with newer APIs and techniques. Consider everything experimental and not recommended for production use.

This will:
- Builds the JS, CSS and HTML files
- Run a local web-server to see you changes
- Live-reloads the browser as changes are made

## Individual gulp tasks

**Browsing locally:** run `gulp serve`

**Wipe-out built files:** run `gulp clean`

**Building all files:** run `gulp build`

**Building HTML:** run `gulp build-templates`
My personal website and general dumping ground to try out my ideas.

**Building JS:** run `gulp build-scripts`
## Running Locally

**Building CSS:** run `gulp build-styles`
Check out [CONTRIBUTING.md](CONTRIBUTING.md) for local setup and commands.
27 changes: 0 additions & 27 deletions assets/bundle/chunks/chunk-MD3C3WXH.js

This file was deleted.

Loading
Loading