Giter VIP home page Giter VIP logo

jun-low.github.io's Introduction

Portfolio v2

๐Ÿ‘‹ Introduction

This is the repository for my portfolio (version 2). I have created this portfolio with create-astro and published it to Github Pages. A live demo can be viewed here.

๐Ÿง‘โ€๐Ÿš€ Functionality

All functionality has been built of November 23rd, 2022. I have plans to add more micro-interactions and projects in the future, such as improving a11y, adding parallax scrolling for mobile, and adding more intro page transitions.

Features:

  • โœ… Tailwind CSS for styling
  • โœ… Themeable Dark mode
  • โœ… 100/100 Lighthouse performance
  • โœ… SEO-friendly with canonical URLs
  • โœ… OpenGraph data for social media sharing
  • โœ… Sitemap support
  • โœ… Responsive support (layout, images, typography)
  • โœ… Astro Prettier setup

๐Ÿš€ Project Structure

Inside of the Astro project, you'll see the following folders and files:

โ”œโ”€โ”€ public/
โ”œโ”€โ”€ src/
โ”‚ย ย  โ”œโ”€โ”€ assets/ # Images for the website
โ”‚ย ย  โ”œโ”€โ”€ components/ # File used for DOM rendering
โ”‚ย ย  โ”œโ”€โ”€ icons/ # Icons for the website
โ”‚ย ย  โ”œโ”€โ”€ layouts/ # Shared layout for the website
โ”‚ย ย  โ””โ”€โ”€ pages/ # Main page
โ”‚ย ย  โ””โ”€โ”€ styles/ # Theme css with light and dark mode
โ”œโ”€โ”€ .prettierrc.json # Lint styles config file
โ”œโ”€โ”€ astro.config.mjs # Astro config tools file
โ”œโ”€โ”€ package-lock.json # Npm package manager file
โ”œโ”€โ”€ package.json # Npm package manager file
โ”œโ”€โ”€ README.md - This file.
โ”œโ”€โ”€ tailwind.config.cjs # Tailwind config file
โ””โ”€โ”€ tsconfig.json # Typescript config

Astro looks for .astro files in the src/pages/ directory. Each page is exposed as a route based on its file name.

There's nothing special about src/components/, but that's where we like to put any Astro/React/Vue/Svelte/Preact components.

Any static assets, like images, can be placed in the public/ directory.

๐Ÿงž Commands

Running in Development Mode

Clone the repository before running in development mode: git clone [email protected]:jun-low/portfolio-v2.git

All commands are run from the root of the project, from a terminal:

Command Action
npm install Installs dependencies
npm run dev Starts local dev server at localhost:3000
npm run build Build your production site to ./dist/
npm run preview Preview your build locally, before deploying
npm run astro ... Run CLI commands like astro add, astro check
npm run astro --help Get help using the Astro CLI

โœ๏ธ Credit

This theme is based off of the lovely Bear Blog and Astro Moon Landing.

jun-low.github.io's People

Contributors

dependabot[bot] avatar imgbotapp avatar jun-low avatar

Watchers

 avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.