godex

package module

v0.0.0-...-3f4e590 Latest Latest Go to latest Published: Oct 15, 2019 License: GPL-3.0 Imports: 3 Imported by: 0

Details

Valid go.mod file

The Go module system was introduced in Go 1.11 and is the official dependency management solution for Go.
Redistributable license

Redistributable licenses place minimal restrictions on how software can be used, modified, and redistributed.
Tagged version

Modules with tagged versions give importers more predictable builds.
Stable version

When a project reaches major version v1 it is considered stable.
Learn more about best practices

Repository

github.com/AdhityaRamadhanus/godex

Links

Open Source Insights

README ¶

godex

Experimental golang cli with DDD-ish design for pokedex item and pokemon information search

godex

Experimental golang cli with DDD-ish design for pokedex item and pokemon information search

Entities: Item Pokemon Ability

Installation | Installation (with docker) | Usage | License

godex is pokedex information search using https://pokeapi.co/api/v2 as backend.

Installation

go get github.com/AdhityaRamadhanus/godex
cd to project dir
run build

make build

run ./godex

Installation With Docker

go get github.com/AdhityaRamadhanus/godex
cd to project dir
run build image

docker build -t godex .

run ./godex

docker run -it godex [pokemon/item name]

Usage

./gode [pokemon/item name]

License

MIT © [Adhitya Ramadhanus]

Documentation ¶

Index ¶

func Capitalize(text string, separator string) string
func Slugify(text string) string
type Abilities
type Ability
- func (a Ability) String() string
type Item
- func (i Item) String() string
type Pokemon
- func (p Pokemon) String() string

Constants ¶

This section is empty.

Variables ¶

This section is empty.

Functions ¶

func Capitalize ¶

func Capitalize(text string, separator string) string

Capitalize return string capitalized with specific separator

func Slugify ¶

func Slugify(text string) string

Slugify return a human readable slug of a text

Types ¶

type Abilities ¶

type Abilities []Ability

type Ability ¶

type Ability struct {
	ID      int
	Name    string
	Effects []string
}

Ability domain entity representing https://pokeapi.co/docs/v2.html/#abilities

func (Ability) String ¶

func (a Ability) String() string

type Item ¶

type Item struct {
	Effects []string
	Name    string
	Cost    uint
}

Item domain entity representing https://pokeapi.co/docs/v2.html/#items-section

func (Item) String ¶

func (i Item) String() string

type Pokemon ¶

type Pokemon struct {
	Abilities Abilities
	Name      string
	ID        int
	Types     []string
}

Pokemon domain entity representing https://pokeapi.co/docs/v2.html/#pokemon-section

func (Pokemon) String ¶

func (p Pokemon) String() string

Source Files ¶

View all Source files

Directories ¶

Path	Synopsis
ability
cmd
item
mocks
pokemon

?	: This menu
/	: Search site
f or F	: Jump to
y or Y	: Canonical URL