https://github.com/lurumad/tokotsu

https://github.com/lurumad/tokotsu

Last synced: 9 days ago
JSON representation

• Host: GitHub
• URL: https://github.com/lurumad/tokotsu
• Owner: lurumad
• License: mit
• Created: 2021-05-27T07:59:36.000Z (over 3 years ago)
• Default Branch: master
• Last Pushed: 2021-05-27T10:20:18.000Z (over 3 years ago)
• Last Synced: 2024-04-14T12:58:58.769Z (7 months ago)
• Language: JavaScript
• Size: 741 KB
• Stars: 0
• Watchers: 4
• Forks: 0
• Open Issues: 1
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        
## 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](https://api.github.com/octocat) and return the Zen quote of the day. E.g.:

### Demo (sucess)

![out](https://user-images.githubusercontent.com/1078545/57860397-bc7ff380-77ec-11e9-80f8-39e02ef3c035.gif)

### Demo (failure)

![out](https://user-images.githubusercontent.com/1078545/57860396-bc7ff380-77ec-11e9-8f55-83b879e667d2.gif)

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!

## Upload the coverage report into [Codecov](https://about.codecov.io/)

Workflow is calling codecov action that upload the coverage from every pull request to codecov platform