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

https://github.com/davidjeddy/isitisekai

Is your favorite anime an isekai? Check at isitisekai.com!
https://github.com/davidjeddy/isitisekai

Last synced: 3 months ago
JSON representation

Is your favorite anime an isekai? Check at isitisekai.com!

Awesome Lists containing this project

README

          

# IsItIsekai.com

## Badges

Build Status, Code Coverage, PR stats/time frame, Project status, etc.

## Description

Is your favorite anime an isekai? Check at isitisekai.com!

## Purpose

Recent history has seen the anime genre of isekai explode in quantity. With this amazing growth it is hard to know if a specific show is isekai or not. Worry no longer! isitisekai.com is here to rescue you!

## Functionality

This project will tell you is an anime is of the isekai genre or not.

## Table of Contents

- [IsItIsekai.com](#isitisekaicom)
- [Badges](#badges)
- [Description](#description)
- [Purpose](#purpose)
- [Functionality](#functionality)
- [Table of Contents](#table-of-contents)
- [Contributing](#contributing)
- [Code of Conduct](#code-of-conduct)
- [Contributing Guidelines](#contributing-guidelines)
- [Development Documentation](#development-documentation)
- [RoadMap](#roadmap)
- [Requirements](#requirements)
- [Runbook](#runbook)
- [Usage](#usage)
- [Download](#download)
- [Configure](#configure)
- [Configure IAC](#configure-iac)
- [Execute](#execute)
- [Execute IAC](#execute-iac)
- [Terminate](#terminate)
- [Testing](#testing)
- [Update](#update)
- [Stop / Destroy](#stop--destroy)
- [Versioning](#versioning)
- [References and Sources](#references-and-sources)
- [CSS](#css)
- [Terraform](#terraform)
- [Javascript](#javascript)
- [Contributors](#contributors)
- [Additional Information](#additional-information)

## Contributing

### Code of Conduct

Please see [CODE_OF_CONDUCT.md](./CODE_OF_CONDUCT.md).

### Contributing Guidelines

Please see [CONTRIBUTING_GUIDELINES.md](./CONTRIBUTING_GUIDELINES.md).

### Development Documentation

Please see [DEVELOPMENT.md](./DEVELOPMENT.md).

## RoadMap

Upcoming planned project changes and feature adds.

[./ROADMAP.md](./ROADMAP.md)

## Requirements

- [POSIX terminal](https://en.wikipedia.org/wiki/POSIX_terminal_interface) and a shell
- [Git](https://git-scm.com/)
- [AWS CLI](https://aws.amazon.com/cli/)
- [IAM user API id and key](https://docs.aws.amazon.com/IAM/latest/UserGuide/id_credentials_access-keys.html)
- [IAM user with permissions](./libs/iam_user_policy.json)
- [Terraform Cloud](https://cloud.hashicorp.com/products/terraform)
- [Terraform](https://www.terraform.io/) >=1.1.6
- [Terragrunt](https://terragrunt.gruntwork.io/) >=0.36
- [k6 open source](https://k6.io/open-source/)

## Runbook

A collection of errors and corrective actions within the scope of this project.

[./RUNBOOK](./RUNBOOK.md)

## Usage

### Download

```sh
git clone https://github.com/davidjeddy/windblows
# auth to access remote state storage
terraform login
# auth to access budget reporting
infracost auth login
```

### Configure

#### Configure IAC

```sh
cd /root_of_project/iac/aws/prd/${AWS_REGION}/${RND_STR}
# Configure providers
vi providers.tf
# Configure state
vi terraform.tf
# Install providers
terragrunt init
# Create init cost report
infracost breakdown --format json --out-file infracost-base.json --path .
# Init tflint libraries
tflint --init
```

### Execute

#### Execute IAC

```sh
terragrunt plan
terragrunt apply
```

### Terminate

Terminate IAC resources via updating configuration. DO NOT `destroy` any resources.

#### Testing

```sh
cd /root_of_project/testing/k6
k6 run \
--env HOSTNAME=windblows.com \
--log-output file=$(date +%s).log \
--quiet \
get.js \
| tee $(date +%s).log
```

### Update

```sh
terragrunt plan
# check the listed changes
terragrunt apply
# `yes` then [ENTER] when prompted
```

### Stop / Destroy

```sh
cd ./terraform/prd
terragrunt destroy
# `yes` [ENTER] when prompted
```

## Versioning

This project follows [SemVer 2.0](https://semver.org/).

```quote
Given a version number MAJOR.MINOR.PATCH, increment the:

1. MAJOR version when you make incompatible API changes,
2. MINOR version when you add functionality in a backwards compatible manner, and
3. PATCH version when you make backwards compatible bug fixes.

Additional labels for pre-release and build metadata are available as extensions to the MAJOR.MINOR.PATCH format.
```

## References and Sources

### CSS

-
-
-
-

### Terraform

-

### Javascript

-
-
-

## Contributors

## Additional Information

- Adding visual aids to any / all the above sections above is recommended.
- [Contributes](##Contributors) sources from [all-contributors](https://github.com/all-contributors/all-contributors).
- [ROADMAP](./ROADMAP.md) example from [all-contributors/all-contributors](https://github.com/all-contributors/all-contributors/blob/master/MAINTAINERS.md).
- Based on [README Maturity Model](https://github.com/LappleApple/feedmereadmes/blob/master/README-maturity-model.md); strive for a Level 5 `Product-oriented README`.
- This Code of Conduct is adapted from the [Contributor Covenant](https://www.contributor-covenant.org), version 2.0, available at [contributor-covenant/code_of_conduct.html](https://www.contributor-covenant.org/version/2/0/code_of_conduct.html).
- [CONTRIBUTING.md](./CONTRIBUTING.md) is based on the [Ruby on Rails Contributing](https://github.com/rails/rails/blob/master/CONTRIBUTING.md) document, credit is due to them.
- [LICENSE](./LICENSE.md) sources from:
- [https://choosealicense.com](https://choosealicense.com)
- [https://en.wikipedia.org/wiki/All_rights_reserved](https://en.wikipedia.org/wiki/All_rights_reserved)
- [SECURITY.md](./SECURITY.md) based from [ISARA Radiate Security Solution Suite 2.0 Security Issues](https://github.com/isaracorp/Toolkit-Samples/edit/master/SECURITY.md).