chaseadams.io v2.2.0

title: "Site Guide" description: "Learn about the site topology for chaseadams.io." slug: "/site-guide/" date: "2018-07-01" updated: "2019-04-02"

aliases: "/site-architecture"

chaseadams.io

chaseadams.io is a statically generated site built with GatsbyJS and deployed with Netlify.

Uses

Tools:

• GatsbyJS (build tool)
• React
• MDX (markdown+jsx)
• Emotion (css-in-js)
• PrismJS (code highlighting)

Hosting/Deployment:

• Netlify (deploy/hosting)
• GitHub (git hosting/continuous integration/deploy scheduler)

Gates:

• Lint: ESLint
• Testing Framework: Jest
• Code Formatting: Prettier
• Static Type Checker: Flow
• Git Hooks: Husky and Lint Staged

Contributing to chaseadams.io

Thanks for your interest in contributing!

Find something that needs fixing? Submit an issue on GitHub

Want to submit a patch? Submit a Merge Request

Development

Running chaseadams.io requires NodeJS and Yarn.

Requirements

• NodeJS ^10.1.0 (JavaScript runtime)
• Yarn package manager ^1.13.0

Install NodeJS and Yarn with NVM

I recommend using nvm (node version manager) to install NodeJS and Yarn. You can find instructions for installing nvm in the GitHub README.md

Once installed, you'll notice that there is an .nvmrc in this project. nvm will use this file to determine the version of NodeJS to use.

If you haven't installed the verison required in the .nmvrc, you can do so by run nvm install without the version while in this directory and it will install it. Then you can run nvm use and it will use the current version.

Once you've followed the instructions for cloning the project, you can run the following to install and use the correct node version:

cd <PATH/TO>/chaseonsoftware
nvm install && nvm use

Note: When changing into other project directories, run nvm use to use the required version for those projects.

Getting Started

Clone the source from GitHub:

git clone git@github.com:chaseadamsio/chaseonsoftware.git && cd chaseonsoftware

Install the node dependencies:

yarn install

Start the Gatsby development server & open http://localhost:8000:

yarn develop && open http://localhost:8000

Now you should be up and running!

Tasks

• develop - run the Gatsby development server.