/git-go

Sample project for git presentation

Primary LanguageJavaScriptCreative Commons Zero v1.0 UniversalCC0-1.0

git-go

This is a sample project for learning git

This is a React application that is deployed to GitHub Pages and should be accessible here

Dev Environment

To test locally, make sure all npm dependencies are installed via

npm install

then run the React development server via

npm run start

This should open your default browser at http://localhost:3000/git-go. Changing the source should dynamically reload the site for fast feedback while making changes.

Deploying

To deploy, make sure to have npm dependencies installed via

npm install

then run the deploy step

npm run deploy

this will

Markdown

May as well learn a sprinkle of Markdown while you're here!

Markdown is a simple way of creating documents with features such as

  • Bulleted lists
  • Links like this one to Google
  • Miscelaneous text markup like Bold, Italized
  • Quote blocks:

It is said that text maketh documentation

  • Code blocks:
let some_javascript_code = "let some_javascript_code = ";
console.log(some_javascript_code);
  • Inline images:

Because it's text-based, it's easy to properly version in source control tools because you can actually 'diff' two versions to track changes.

Markdown has become a popular way of at the very least having a README.md file in your repo which describes and documents it in some way.