Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/codeaholicguy/wowcup

⚽ 💻 The finest Worldcup 2018 CLI.
https://github.com/codeaholicguy/wowcup

cli oclif scoreboard typescript worldcup worldcup2018

Last synced: 18 days ago
JSON representation

⚽ 💻 The finest Worldcup 2018 CLI.

Host: GitHub
URL: https://github.com/codeaholicguy/wowcup
Owner: codeaholicguy
License: mit
Created: 2018-06-09T15:56:07.000Z (over 6 years ago)
Default Branch: master
Last Pushed: 2022-12-03T03:20:04.000Z (almost 2 years ago)
Last Synced: 2024-10-15T01:42:36.171Z (29 days ago)
Topics: cli, oclif, scoreboard, typescript, worldcup, worldcup2018
Language: TypeScript
Homepage: https://www.npmjs.com/package/wowcup
Size: 271 KB
Stars: 180
Watchers: 4
Forks: 10
Open Issues: 13
Metadata Files:
- Readme: README.md
- License: LICENSE

Awesome Lists containing this project

README

        wowcup

======

The finest Worldcup 2018 CLI. Inspired by [nba-go](https://github.com/xxhomey19/nba-go).

`wowcup` is a node command line application written in TypeScript using [oclif](https://github.com/oclif/oclif) (a Node.JS Open CLI Framework).

This is still in its early stages of development, so do expect bugs and errors. Your contributions are very welcome!

All data comes from [api.football-data.org](https://api.football-data.org) APIs.

[![oclif](https://img.shields.io/badge/cli-oclif-brightgreen.svg)](https://oclif.io)

[![Version](https://img.shields.io/npm/v/wowcup.svg)](https://npmjs.org/package/wowcup)

[![CircleCI](https://circleci.com/gh/codeaholicguy/wowcup/tree/master.svg?style=shield)](https://circleci.com/gh/codeaholicguy/wowcup/tree/master)

[![Appveyor CI](https://ci.appveyor.com/api/projects/status/github/codeaholicguy/wowcup?branch=master&svg=true)](https://ci.appveyor.com/project/codeaholicguy/wowcup/branch/master)

[![Codecov](https://codecov.io/gh/codeaholicguy/wowcup/branch/master/graph/badge.svg)](https://codecov.io/gh/codeaholicguy/wowcup)

[![Downloads/week](https://img.shields.io/npm/dw/wowcup.svg)](https://npmjs.org/package/wowcup)

[![License](https://img.shields.io/npm/l/wowcup.svg)](https://github.com/codeaholicguy/wowcup/blob/master/package.json)

* [Usage](#usage)

* [Commands](#commands)

# Usage

```sh-session

$ npm install -g wowcup

$ wowcup COMMAND

running command...

$ wowcup (-v|--version|version)

wowcup/0.0.7 darwin-x64 node-v10.3.0

$ wowcup --help [COMMAND]

USAGE

  $ wowcup COMMAND

...

```

## Usage

`wowcup` provides two main commands.

1. fixtures

![](https://i.gyazo.com/a562d442af729c3b59f34110008d5ed0.gif)

2. standings

![](https://i.gyazo.com/19a5a39b69613baa4154f892a0a8d9b8.gif)

# Commands

* [`wowcup fixtures`](#wowcup-fixtures)

* [`wowcup help [COMMAND]`](#wowcup-help-command)

* [`wowcup standings`](#wowcup-standings)

## `wowcup fixtures`

get worldcup fixtures

```

USAGE

  $ wowcup fixtures

OPTIONS

  -h, --help     show CLI help

  -l, --last     get last recent fixtures in 24h

  -n, --next     get next recent fixtures in 24h

  -p, --playing  get playing fixtures

  -q, --quiet    do not show splash header

EXAMPLES

  $ wowcup fixtures

  $ wowcup fixtures -n

  $ wowcup fixtures -l

  $ wowcup fixtures -p

```

_See code: [src/commands/fixtures.ts](https://github.com/codeaholicguy/wowcup/blob/v0.0.7/src/commands/fixtures.ts)_

## `wowcup help [COMMAND]`

display help for wowcup

```

USAGE

  $ wowcup help [COMMAND]

ARGUMENTS

  COMMAND  command to show help for

OPTIONS

  --all  see all commands in CLI

```

_See code: [@oclif/plugin-help](https://github.com/oclif/plugin-help/blob/v2.0.5/src/commands/help.ts)_

## `wowcup standings`

get worldcup standings

```

USAGE

  $ wowcup standings

OPTIONS

  -h, --help         show CLI help

  -q, --quiet        do not show splash header

  -t, --table=table  get standings by table

EXAMPLES

  $ wowcup standings

  $ wowcup standings -t a

```

_See code: [src/commands/standings.ts](https://github.com/codeaholicguy/wowcup/blob/v0.0.7/src/commands/standings.ts)_

## Development

The following is step-by-step instruction to run `wowcup` on your local computer.

```

$ git clone https://github.com/codeaholicguy/wowcup.git

$ cd wowcup

$ yarn

$ bin/run 

```

## License

[MIT](LICENSE)