alexieyizhe / portfolio-v1

First iteration of my personal website. For the most up-to-date version, see https://github.com/alexieyizhe/portfolio

Geek Repo:Geek Repo

Github PK Tool:Github PK Tool

alexieyizhe.me

Coveralls github branch Deploys with Netlify code style: prettier GitHub license

Note: a redesign of my website is under active development. If interested, check out the dev branch for the latest changes.

Personal website/portfolio of Alex Yizhe Xie.

Custom built, from the props up.
Powered by React and GatsbyJS.
Follows Airbnb and Prettier coding style.
Tests written with Jest + Enzyme/React Test Renderer.
Continuous integration through TravisCI.
Deploys from Netlify.

Check it out here!

Setting up

  • Use git clone to clone this repository. Alternatively, download the source code.
  • Make sure required dependencies have been installed using npm install.

Development and testing

  • Execute:
    • gatsby develop to view site in development mode with hot reloading enabled.
    • npm run test to run tests and generate code coverage results.
    • npm run test:update to run tests and update snapshots if necessary.
    • npm run lint to run ESLint and check for improper code.
    • npm run prettier to format files in accordance with Prettier.
    • npm run prettier:check to see if Prettier style is being followed.
  • All tests live in the /test directory. All source code can be found in the /src directory. The /static folder holds resources like images and documents used on the website.

Building for production

  • Run gatsby build to generate a production optimized build. Files and artifacts will be stored in the /static directory.
  • Run gatsby serve for a local production version of the site.
  • Host on your favourite static site CMS or hosting serv-wait, you really shouldn't need to host my personal website yourself...

About

First iteration of my personal website. For the most up-to-date version, see https://github.com/alexieyizhe/portfolio

License:MIT License


Languages

Language:HTML 55.7%Language:JavaScript 41.0%Language:CSS 3.0%Language:Shell 0.2%