Skip to content
/ mirror Public template

A personal website template, simple configuration

License

Notifications You must be signed in to change notification settings

songlim327/mirror

Repository files navigation

svelte-badge project

Mirror 🪞

Welcome to the mirror repository! This project provides a robust and customizable template for creating a sleek, modern and professional look portfolio website. The template is perfect for developers with a github account to showcase their projects. Most of the information comes from github, thus minimal configuration is required to run.

Showcase 🦄

showcase

Getting Started 🤖

Prerequisites

Everything you need to build this project are listed below:

Fork and clone

Fork the repository and clone to local to run:

git clone https://github.com/<YOUR_GITHUB_USERNAME>/mirror.git
cd mirror

Installation

Install the project dependencies by running command below.

npm install

Running the Project

npm run start

Open http://localhost:5173 in your browser to view the project.

Usage 🐾

Customize the config file in config directory

Eg:

export const config: Record<string, string> = {
	name: 'Song Lim',
	github: 'songlim327',
	email: '[email protected]',
	profilePicture: 'https://avatars.githubusercontent.com/u/36408539?v=4',
	description:
		'Hi, good to see you here. I am Song Lim, a currently full time software engineer, is passionate and dedicated in exploring and crafting innovative solutions, delivering high-quality and efficient code. I thrive on continuous learning and explore the latest technologies and industry trends.',
	linkedin: 'https://www.linkedin.com/in/songlim-327/',
	facebook: 'https://www.facebook.com/song.lim.18/',
	stackoverflow: 'https://stackoverflow.com/users/11543339/song-lim',
	twitter: 'https://x.com/songlim666',
	resume: ''
} as const;

Google Analytics 4

If you wish to use Google Analytics on your website, copy .env.example and rename it to .env. Add the id to the file as follows:

PUBLIC_GA4=<your-GA4-ID>

Package used 📦

Packages
svelte
tailwindcss
@tanstack/svelte-query
lucide-svelte
typed.js
shadcn-svelte

About

A personal website template, simple configuration

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published