https://github.com/yeehanchung/yeehanchung.com

My 1st personal website, built with Gatsby.
https://github.com/yeehanchung/yeehanchung.com

gatsby portfolio react styled-components

Last synced: 3 days ago
JSON representation

My 1st personal website, built with Gatsby.

• Host: GitHub
• URL: https://github.com/yeehanchung/yeehanchung.com
• Owner: yeehanchung
• Created: 2020-11-26T17:15:11.000Z (almost 4 years ago)
• Default Branch: main
• Last Pushed: 2024-01-01T05:50:56.000Z (11 months ago)
• Last Synced: 2024-01-01T06:38:48.864Z (11 months ago)
• Topics: gatsby, portfolio, react, styled-components
• Language: TypeScript
• Homepage: https://v1.yeehanchung.com/
• Size: 99.4 MB
• Stars: 2
• Watchers: 1
• Forks: 0
• Open Issues: 1
• Metadata Files:
  • Readme: README.md

Awesome Lists containing this project

README

        


  

    

  





  


    yeehanchung.com

  

  


    

    

  


  


  



## Pre-requisite

- Installed Gatsby CLI `npm install -g gatsby-cli`

## 🥞 Technologies

Gatsby, JavaScript, styled-components, SCSS, Markdown, etc.

## 🚀 Quick start

1. **Git clone**

   ```shell

   $ git clone https://github.com/cyeehan/yeehan.me.git

   $ cd yeehan.me

   ```

2. **Install dependencies**

   ```shell

   $ yarn install

   ```

3. **Start developing**

   In the main directory,

   ```shell

   $ gatsby develop

   or

   $ yarn start

   ```

   Your site is now running at `http://localhost:8000`

   _Note: You'll also see a second link: _`http://localhost:8000/___graphql`_. This is a tool you can use to experiment with querying your data. Learn more about using this tool in the [Gatsby tutorial](https://www.gatsbyjs.com/tutorial/part-five/#introducing-graphiql)._

## 🧐 What's inside? (Optional)

A quick look at the top-level files and directories you'll see in a Gatsby project.

    .

    ├── node_modules

    ├── src

    ├── .gitignore

    ├── .prettierrc

    ├── gatsby-browser.js

    ├── gatsby-config.js

    ├── gatsby-ssr.js

    ├── LICENSE

    ├── package-lock.json

    ├── package.json

    └── README.md

1.  **`/node_modules`**: This directory contains all of the modules of code that your project depends on (npm packages) are automatically installed.

2.  **`/src`**: This directory will contain all of the code related to what you will see on the front-end of your site (what you see in the browser) such as your site header or a page template. `src` is a convention for “source code”.

3.  **`.gitignore`**: This file tells git which files it should not track / not maintain a version history for.

4.  **`.prettierrc`**: This is a configuration file for [Prettier](https://prettier.io/). Prettier is a tool to help keep the formatting of your code consistent.

5.  **`gatsby-browser.js`**: This file is where Gatsby expects to find any usage of the [Gatsby browser APIs](https://www.gatsbyjs.com/docs/browser-apis/) (if any). These allow customization/extension of default Gatsby settings affecting the browser.

6.  **`gatsby-config.js`**: This is the main configuration file for a Gatsby site. This is where you can specify information about your site (metadata) like the site title and description, which Gatsby plugins you’d like to include, etc. (Check out the [config docs](https://www.gatsbyjs.com/docs/gatsby-config/) for more detail).

7.  **`gatsby-node.js`**: This file is where Gatsby expects to find any usage of the [Gatsby Node APIs](https://www.gatsbyjs.com/docs/node-apis/) (if any). These allow customization/extension of default Gatsby settings affecting pieces of the site build process.

8.  **`gatsby-ssr.js`**: This file is where Gatsby expects to find any usage of the [Gatsby server-side rendering APIs](https://www.gatsbyjs.com/docs/ssr-apis/) (if any). These allow customization of default Gatsby settings affecting server-side rendering.

9.  **`LICENSE`**: This Gatsby starter is licensed under the 0BSD license. This means that you can see this file as a placeholder and replace it with your own license.

10. **`package-lock.json`** (See `package.json` below, first). This is an automatically generated file based on the exact versions of your npm dependencies that were installed for your project. **(You won’t change this file directly).**

11. **`package.json`**: A manifest file for Node.js projects, which includes things like metadata (the project’s name, author, etc). This manifest is how npm knows which packages to install for your project.

12. **`README.md`**: A text file containing useful reference information about your project.

## License

MIT