Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/nathanielmathew/MyPortfolio

A static website of my very own Portfolio built using the blazing fast Gatsby framework🔥
https://github.com/nathanielmathew/MyPortfolio

gatsby gatsbyjs hacktoberfest javascript portfolio portfolio-site portfolio-website static-site

Last synced: 11 days ago
JSON representation

A static website of my very own Portfolio built using the blazing fast Gatsby framework🔥

Awesome Lists containing this project

README 

        





  

    Logo

  

  


  My Portfolio

  


A personal website to showcase my portfolio content online, including- personal information, projects, achievements, and a blog page. Built using The GatsbyJS Framework, this website is static and hence does not require a backend to function. 



_This website runs on GatsbyJS, to install Gatsby, refer [this](https://www.gatsbyjs.org/docs/quick-start/)_



## 🚀 Getting started

1. **Clone the Repository**

    ```sh

    git clone https://github.com/nathanielmathew/MyPortfolio.git

    ```



1.  **Start developing.**



    Navigate into the site’s directory and start it up.



    ```sh

    cd MyPortfolio/

    gatsby develop

    ```



1.  **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](https://www.gatsbyjs.org/tutorial/part-five/#introducing-graphiql)._



    Open the `MyPortfolio` directory in your code editor of choice and 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 Gatsby project.



    .

    ├── node_modules

    ├── src

    ├── .gitignore

    ├── .prettierrc

    ├── gatsby-browser.js

    ├── gatsby-config.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](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.org/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.org/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.org/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.org/docs/ssr-apis/) (if any). These allow customization of default Gatsby settings affecting server-side rendering.



9.  **`LICENSE`**: Gatsby is licensed under the MIT 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 the 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 the project.



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



## 🎓 Learning Gatsby



Looking for more guidance? Full documentation for Gatsby lives [on the website](https://www.gatsbyjs.org/). Here are some places to start:



- **For most developers, we recommend starting with our [in-depth tutorial for creating a site with Gatsby](https://www.gatsbyjs.org/tutorial/).** 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](https://www.gatsbyjs.org/docs/).** In particular, check out the _Guides_, _API Reference_, and _Advanced Tutorials_ sections in the sidebar.