tc-imba's Gatsby Personal Website Template for Academic Usage

This website (template) is based on Gatsby's RolwinReevan Portfolio template using ant-design.

It is rewritten for academic usage with the help of Reapor-Yurnero.

🚀 Development

1. Setup the project by.

   clone the project and install the dependencies

   git clone https://github.com/tc-imba/greatest-gatsby-academic-template.git
   cd greatest-gatsby-academic-template
   yarn

2. Start developing.

   yarn develop

3. 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.

Deployment

Local

yarn
yarn build

Then the static website will be built in the example/public folder. You can use Apache or nginx to serve the content.

github.io

The project also supports automatically deploying through GitHub Actions. It is already configured in .github/workflows/main.yml and typically you do not need to modify it. The static website will be built on the gh-pages branch in your GitHub repo.

🧐 What's inside?

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

.
├── content
├── node_modules
├── src
├── static
├── .eslintrc
├── .example.env
├── .gitignore
├── .prettierrc
├── config.js
├── gatsby-browser.js
├── gatsby-config.js
├── gatsby-config.plugins.js
├── gatsby-node.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. Prettier is a tool to help keep the formatting of your code consistent.

5. config.js: all the configuration variables that are necessary for the site are added in this file.

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-config.plugins.js: This file contains the plugin configurations which is used in the gatsby-config.js. For modularity purpose we do this.

8. 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.

9. 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.

10. LICENSE: Gatsby is licensed under the MIT license.

11. 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).

12. 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.

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

14. content: This is the folder where we write our Markdowns for the blogs.