Ramesh's personal blog started with Gatsby's hello-world starter. Gatsby-starter-hello-world template comes with a skeleton to kick-start a Gatsby-based project.
If you want to start your blog from the scratch, it is recommended you use the hello-world-starter template else, you can use this template which already comes with many settings and plugins (Warning: If you are new to Gatsby, it could be complex to start with someone's template).
My recommendation is to use the hello-world starter template and follow Gatsby JS tutorial for understanding Gatsby and GraphQL better. It will add authenticity to your project and you can always look this or other similar project for inspiration/help.
This blog (major portion) has been created by following Gatsby JS tutorial
- ** Install the Gatsby CLI **
npm install -g gatsby-cli
Clone this (ramesh-blog) repository.
```shell
# create a new Gatsby site using the hello-world starter
git clone https://github.com/rameshkunwar/ramesh-blog.git
```
-
Start developing.
Navigate into blog's (ramesh-blog) directory and start it up.
cd ramesh-blog/ gatsby develop or npm run start
-
Open the source code and start editing!
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.
A quick look at the top-level files and directories you'll see in a Gatsby project.
.
├── node_modules
├── src
|__ static
|___ content
├── .gitignore
├── .prettierrc
├── gatsby-config.js
├── gatsby-node.js
├── yarn.lock
├── LICENSE
├── package-lock.json
├── package.json
└── README.md
-
/node_modules
: This directory contains all of the modules of code that your project depends on (npm packages) are automatically installed. -
/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”. -
/content
: This directory contains all blog posts as well as images used in the blog posts. -
.gitignore
: This file tells git which files it should not track / not maintain a version history for. -
.prettierrc
: This is a configuration file for Prettier. Prettier is a tool to help keep the formatting of your code consistent. -
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). -
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. -
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. -
package-lock.json & yarn.lock
(Seepackage.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). -
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. -
README.md
: A text file containing useful reference information about your project. -
site-config.js
: Detailed info about author, colors, etc saved centrally so this file can be referenced. -
/static
: Files, folders that Gatsby has nothing to do on build process should be placed here. It will be copied as it is during build.