Skip to content

Commit

Permalink
Update README.md
Browse files Browse the repository at this point in the history
  • Loading branch information
chandrikadeb7 authored Apr 20, 2024
1 parent 1d53174 commit bc930ae
Showing 1 changed file with 20 additions and 33 deletions.
53 changes: 20 additions & 33 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,85 +1,72 @@
<div align="center">
<img alt="Logo" src="https://raw.githubusercontent.com/bchiang7/v4/main/src/images/logo.png" width="100" />
<img alt="Logo" src="https://github.com/chandrikadeb7/chandrikadeb7.github.io/blob/code/src/images/logo.png" width="100" />
</div>
<h1 align="center">
brittanychiang.com - v4
Personal Portfolio Website
</h1>
<p align="center">
The fourth iteration of <a href="https://brittanychiang.com" target="_blank">brittanychiang.com</a> built with <a href="https://www.gatsbyjs.org/" target="_blank">Gatsby</a> and hosted with <a href="https://www.netlify.com/" target="_blank">Netlify</a>
The second iteration of <a href="https://chandrikadeb7.github.io/" target="_blank">chandrikadeb7.github.io</a> built with <a href="https://www.gatsbyjs.org/" target="_blank">Gatsby</a> and hosted using <a href="https://pages.github.com/" target="_blank">Github Pages</a>
</p>
<p align="center">
Previous iterations:
<a href="https://github.com/bchiang7/v1" target="_blank">v1</a>,
<a href="https://github.com/bchiang7/v2" target="_blank">v2</a>,
<a href="https://github.com/bchiang7/bchiang7.github.io" target="_blank">v3</a>
<a href="https://github.com/chandrikadeb7/chandrikadeb7.github.io-v1" target="_blank">Version 1</a>
</p>
<p align="center">
<a href="https://app.netlify.com/sites/brittanychiang/deploys" target="_blank">
<img src="https://api.netlify.com/api/v1/badges/1963b488-7b78-48c9-9e2d-6fb5e47ab3af/deploy-status" alt="Netlify Status" />
</a>
</p>

![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/).
<div align="center">
<img alt="Demo" src="https://github.com/chandrikadeb7/chandrikadeb7.github.io/blob/code/src/images/demo.png" />
</div>

### 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

| 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` |
Expand Down

0 comments on commit bc930ae

Please sign in to comment.