GitHub workshop
Перейти к файлу
Tamer Maher 8d04ef5f3f Create testFile.txt 2020-02-18 11:00:19 -05:00
.github/workflows Create nodejs.yml 2020-02-18 10:20:39 -05:00
lib initial commit 2020-02-18 10:04:39 -05:00
test initial commit 2020-02-18 10:04:39 -05:00
views initial commit 2020-02-18 10:04:39 -05:00
.gitignore initial commit 2020-02-18 10:04:39 -05:00
CODE_OF_CONDUCT.md Initial CODE_OF_CONDUCT.md commit 2020-02-18 06:51:31 -08:00
LICENSE Initial LICENSE commit 2020-02-18 06:51:32 -08:00
README.md minor update 2020-02-18 10:56:34 -05:00
SECURITY.md Initial SECURITY.md commit 2020-02-18 06:51:33 -08:00
index.js initial commit 2020-02-18 10:04:39 -05:00
out.gif initial commit 2020-02-18 10:04:39 -05:00
out2.gif initial commit 2020-02-18 10:04:39 -05:00
package-lock.json initial commit 2020-02-18 10:04:39 -05:00
package.json initial commit 2020-02-18 10:04:39 -05:00
testFile.txt Create testFile.txt 2020-02-18 11:00:19 -05:00
testpolicy.txt Update testpolicy.txt 2020-02-18 10:55:28 -05:00

README.md

Welcome

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)

out

Demo (failure)

out

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 

Tests:

npm run test

Run server (defaults to localhost:3000):

npm start

Follow the coach instructions and good luck!