https://github.com/utsavll0/personal-website
https://github.com/utsavll0/personal-website
Last synced: 24 days ago
JSON representation
- Host: GitHub
- URL: https://github.com/utsavll0/personal-website
- Owner: utsavll0
- License: gpl-3.0
- Created: 2024-04-27T00:42:12.000Z (about 2 years ago)
- Default Branch: main
- Last Pushed: 2025-02-24T05:48:38.000Z (over 1 year ago)
- Last Synced: 2025-02-24T06:34:56.200Z (over 1 year ago)
- Language: Svelte
- Homepage: https://personal-website-two-tan.vercel.app
- Size: 28.6 MB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# Building & Running Locally
To run it locally, you simply have to run:
```shell
# First, install dependencies
npm install
# Then, run it on dev mode
npm run dev
```
The site should now be available at http://localhost:5173/ on your local machine, and your local machine's IP address on your network—great for testing on mobile OSes.
# Histoire / Storybook
I've used [Histoire](https://histoire.dev), a Vite-based Storybook alternative to be able to see and develop components in isolation. To open it, run `npm run story:dev`.
# Image Optimization
This website uses [image-transmutation](https://github.com/matfantinel/image-transmutation) to automatically optimize images used in the site. This means that even if you use non-optimal image formats (like lossless PNGs), it will go over the images and convert images to WebP and AVIF for you, as long as you use the `` component instead of `![]()
`. This is done on build, so it doesn't change anything when running the website locally.
# Managing Posts
All posts are Markdown files that are processed with [MDsveX](https://mdsvex.pngwn.io/) to allow using Svelte components inside them. In order to make it easier to manage posts, I highly recommend the [Front Matter VS Code extension](https://frontmatter.codes/), which gives you a nice CMS-like UI.
# Hosting
When you run `npm run build`, the website will be compiled into a static site, which means you can host it pretty much anywhere. Some free alternatives I recommend are GitHub Pages, Vercel and Netlify.