diff --git a/README.md b/README.md index 990c3f027..ca49c9533 100644 --- a/README.md +++ b/README.md @@ -1,76 +1,63 @@
- Logo + Logo

- brittanychiang.com - v4 + Personal Portfolio Website

- The fourth iteration of brittanychiang.com built with Gatsby and hosted with Netlify + The second iteration of chandrikadeb7.github.io built with Gatsby and hosted using Github Pages

Previous iterations: - v1, - v2, - v3 + Version 1

-

- - Netlify Status - -

- -![demo](https://raw.githubusercontent.com/bchiang7/v4/main/src/images/demo.png) - -## 🚨 Forking this repo (please read!) -Many people have contacted me asking me if they can use this code for their own website, and the answer to that question is usually **yes, with attribution**. - -I value keeping my site open source, but as you all know, _**plagiarism is bad**_. It's always disheartening whenever I find that someone has copied my site without giving me credit. I spent a non-trivial amount of effort building and designing this iteration of my website, and I am proud of it! All I ask of you all is to not claim this effort as your own. - -Please also note that I did not build this site with the intention of it being a starter theme, so if you have questions about implementation, please refer to the [Gatsby docs](https://www.gatsbyjs.org/docs/). +
+ Demo +
### TL;DR -Yes, you can fork this repo. Please give me proper credit by linking back to [brittanychiang.com](https://brittanychiang.com). Thanks! +Yes, you can fork this repo. Please give proper credit by linking back to [brittanychiang.com](https://brittanychiang.com). Thanks! ## 🛠 Installation & Set Up -1. Install the Gatsby CLI +1. Install the Gatsby CLI (Use npm 10) ```sh npm install -g gatsby-cli ``` -2. Install and use the correct version of Node using [NVM](https://github.com/nvm-sh/nvm) +2. Install and use the correct version of Node (18 or 20) using [NVM](https://github.com/nvm-sh/nvm) ```sh - nvm install + nvm install --force ``` -3. Install dependencies +3. Build using Gatsby ```sh - yarn + gatsby build ``` -4. Start the development server +4. Start the development server (localhost) ```sh npm start ``` -## 🚀 Building and Running for Production +## 🚀 Building and Running for Production (GitHub Pages) 1. Generate a full static production build ```sh - npm run build + gatsby build ``` -1. Preview the site as it will appear once deployed +2. Push to production ```sh - npm run serve + npm run deploy ``` ## 🎨 Color Reference @@ -78,8 +65,8 @@ Yes, you can fork this repo. Please give me proper credit by linking back to [br | Color | Hex | | -------------- | ------------------------------------------------------------------ | | Navy | ![#0a192f](https://via.placeholder.com/10/0a192f?text=+) `#0a192f` | -| Light Navy | ![#112240](https://via.placeholder.com/10/0a192f?text=+) `#112240` | -| Lightest Navy | ![#233554](https://via.placeholder.com/10/303C55?text=+) `#233554` | +| Light Navy | ![#172a45](https://via.placeholder.com/10/0a192f?text=+) `#172a45` | +| Lightest Navy | ![#303C55](https://via.placeholder.com/10/303C55?text=+) `#303C55` | | Slate | ![#8892b0](https://via.placeholder.com/10/8892b0?text=+) `#8892b0` | | Light Slate | ![#a8b2d1](https://via.placeholder.com/10/a8b2d1?text=+) `#a8b2d1` | | Lightest Slate | ![#ccd6f6](https://via.placeholder.com/10/ccd6f6?text=+) `#ccd6f6` |