Ecosyste.ms: Awesome

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

Awesome Lists | Featured Topics | Projects

https://github.com/brenopanzolini/pokelmon

Elm project consuming PokéAPI
https://github.com/brenopanzolini/pokelmon

elm pokemon

Last synced: 28 days ago
JSON representation

Elm project consuming PokéAPI

Awesome Lists containing this project

README

        

# Pokelmon [![Build Status](https://travis-ci.org/brenopanzolini/pokelmon.svg?branch=master)](https://travis-ci.org/brenopanzolini/pokelmon)

![Pokelmon](http://i.imgur.com/JPNfcv3.png)

Simple Elm project consuming [PokéAPI](https://pokeapi.co/).

[Demo](http://pokelmon.surge.sh/).

## Requirements

- Elm version 0.18 _([official install guide](http://elm-lang.org/install))_
- To run `elm` using Docker: `alias elm='docker run -it --rm -v "$(pwd):/code" -w "/code" -e "HOME=/tmp" -u $UID:$GID -p 8000:8000 codesimple/elm:0.18'`

## Getting Started

```sh
$ git clone https://github.com/brenopanzolini/pokelmon.git
$ cd pokelmon
```

Then install dependencies:

```sh
$ elm-package install
```

## Running the Project

You can start the project by running:

```
$ yarn start
```

This will execute *elm-reactor* and you can access the project in http://localhost:8000.

## Building the Project

You can build the project by running:

```
$ yarn build
```

This will generate the compiled files in *dist/built* folder.