workshop-tonkotsu-nodejs v0.0.1

Welcome People

This repository contains the base project part of our on-site GitHub Verified Partner workshop program. It is meant to be used for in-classroom training under the supervision of GitHub coaches.

This is the NodeJS version of our "Tonkotsu" workshop webapp. The codebase is pretty simple: it's a NodeJS app that will connect to GitHub's Octocat API endpoint and return the Zen quote of the day. E.g.:

Demo (sucess)

Demo (failure)

There are some built-in unit tests to ensure that everything can be verified.

Instructions

Please fork this repository and ensure you have a local working copy. You will need a working NodeJS environment. Get the latest stable version from https://nodejs.org/en/download/ or via your OS package manager (e.g. brew on Mac or chocolatey on Windows).

Setup:

npm install ; Install node.js Package

Tests:

npm run test

Run server (defaults to localhost:3000):

npm start

Follow the coach instructions and good luck!

changing the readme file