https://github.com/kuy/today-anime

I can't keep in mind a day of the week of my favorite animes' broadcast 😇
https://github.com/kuy/today-anime

ocaml

Last synced: 1 day ago
JSON representation

I can't keep in mind a day of the week of my favorite animes' broadcast 😇

• Host: GitHub
• URL: https://github.com/kuy/today-anime
• Owner: kuy
• Created: 2019-02-10T18:24:54.000Z (almost 6 years ago)
• Default Branch: master
• Last Pushed: 2019-03-16T07:45:25.000Z (almost 6 years ago)
• Last Synced: 2024-11-11T12:39:42.022Z (2 months ago)
• Topics: ocaml
• Language: OCaml
• Homepage:
• Size: 26.4 KB
• Stars: 1
• Watchers: 3
• Forks: 0
• Open Issues: 2
• Metadata Files:
  • Readme: README.md
  • Changelog: CHANGELOG.md

Awesome Lists containing this project

README

        
[![CircleCI](https://circleci.com/gh/kuy/today-anime.svg?style=svg)](https://circleci.com/gh/kuy/today-anime)

# today-anime?

**I can't keep in mind a day of the week of my favorite animes' broadcast 😇**

## Usage

### Installation

Download a latest binary from [Releases](https://github.com/kuy/today-anime/releases) page and extract it anywhere you want.

I recommend you to put the binary at a directory which is already in PATH env.

### Configuration

This application requires [Annict's Personal Access Token](https://annict.jp/settings/apps) to get your programs that is watching now.

To provide the access token to the application, put `.today-anime.json` file to your home directory. Here is an example of the configuration file.

```json

{

  "annict" : {

    "accessToken": "ANNICT ACCESS TOKEN"

  }

}

```

### Run

Simply run `today-anime`.

### Options

#### `--more`

You couldn't watch animes yesterday? No problem, just add this option to show all past 5 days.

## API

### Run

`today-anime-api`

### Endpoints

#### `/today`

`curl -X GET http://localhost:8080/today`

## Development

### Module structure

- `cli`: CLI application executable

- `api`: REST API server executable

- `app`: Core application module

- `annict`: Annict API wrapper

- `syobocal`: Syoboi Calendar API wrapper

### Requirements

- OCaml 4.07.1

- opam 2.0.x

- dune 1.6.x

### Prepare

Create an environment using [opam](https://opam.ocaml.org/doc/Usage.html#opam-switch).

### CLI

#### Run

`dune exec cli/main.exe`

### API

#### Run

`dune exec api/main.exe`