dassidas / personal Goto Github PK

This is a personal site built on Gatsby that I developed a while back. Most of my coding nowadays is in private repos, so I keep this around as an example of my coding style and architectural approach. As an important note, I do work across the stack at this point – so please don't over-index on this purely-frontend project!

Notes about the site:

• This is fairly old work! I was interested in the intersection of SVG and animations at the time, so I used this space to playground some approaches and see what worked well. Other than what's in the playground / tooling sections, it's a simple bio website without much going on.
• I developed this site before learning TypeScript, so I'm relying on React PropTypes, instead.
• I'm a fan of single-file components for many reasons, and I implemented that approach here by way of styled-components.
• The two most complex mini-projects in here are the two tools:
  • The Guitar Scale visualizer, which displays where notes land for a number of different musical scales. I play guitar and this was a fun way to play with different styles.
  • The Color Palette tool, which allows for persistent (per-refresh) updating to the site's color palette. All the colors are programmatically generated from a single base color, which was a fun little challenge to figure out.

Some upgrade plans:

• It'd be nice to update everything to use TypeScript instead of PropTypes. PropTypes are really just limited TypeScript with more boilerplate and fewer benefits.
• I'd like to swap to NextJS to take advantage of their built-in API framework so that I can play around with Node more. (Also, Gatsby really can be a pain sometimes!)
• I could possibly adopt ChakraUI here, which is my component library of choice, since it starts from a far more accessible baseline and offers a variety of stock components to choose from. I'd also take advantage of Chakra's theme and see if I could get the user-editing tool to operate on top of that.

This site is currently not being deployed anywhere. To run the site locally:

1. Clone the repo
2. yarn to install everything
3. yarn dev to expose the app at localhost:8000

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. 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 (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: 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 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.

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.