nmthangdn2000 / nmthangdn2000.github.io

Geek Repo:Geek Repo

Github PK Tool:Github PK Tool

Gatsby

Nguyễn Minh Thắng's Portfolio

A website to introduce about me, my experiences, my projects and anything you want to know.

If you want to run int on your computer, let see the quick guide below.

🚀 Quick start

Install NodeJS version 18.x.x (lts/hydrogen)

# Install NodeJS
nvm install lts/hydrogen

# Use NodeJS
nvm use lts/hydrogen

# Enable Corepack
corepack enable

Install libraries

Using yarn as node package manager.

# Get yarn version with this source
yarn set version from sources

# Install all packages
yarn

# Or install all upgraded packages
npx yarn-upgrade-all

Start the source code

Prepare environment for make Contentful API connection

# Setup environment
cp example.env .env

Start develop server

yarn develop

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.

Edit src/pages/index.js. Save your changes and the browser will update in real time!

🧐 What's inside?

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

.
├── node_modules
├── src
├── static
├── .gitignore
├── gatsby-browser.js
├── gatsby-config.js
├── gatsby-node.js
├── gatsby-ssr.js
├── LICENSE
├── 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. /static: This directory will contain all of the assets provided by themeforest.net package. After add files to this directory, you should update page-body.tsx, page-head.tsx and add the gatsby's config files.

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

  5. gatsby-browser.js: This file is where Gatsby expects to find any usage of the Gatsby 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 for more detail).

  7. gatsby-node.js: This file is where Gatsby expects to find any usage of the Gatsby 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 (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.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.

  11. README.md: A text file containing useful reference information about your project.

🎓 Learning Gatsby

Looking for more guidance? Full documentation for Gatsby lives on the website. Here are some places to start:

  • For most developers, we recommend starting with our in-depth tutorial for creating a site with Gatsby. It starts with zero assumptions about your level of ability and walks through every step of the process.

  • To dive straight into code samples, head to our documentation. In particular, check out the Guides, API Reference, and Advanced Tutorials sections in the sidebar.

💫 Deploy

Already prepared Github Action for deploy this website to Github Page. If you want to run this action, please enable it in .github/deploy-github-page.yml and change the repository to your-username.github.io.

Build, Deploy, and Host On Github Page

Build, Deploy, and Host On Cloudflare Pages

About


Languages

Language:CSS 54.5%Language:HTML 20.3%Language:TypeScript 15.4%Language:JavaScript 9.8%Language:Shell 0.0%