Ecosyste.ms: Awesome

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

Awesome Lists | Featured Topics | Projects

https://github.com/dj0nny/pokencyclopedia

Pokèmon encyclopedia built using Vue.js and Typescript
https://github.com/dj0nny/pokencyclopedia

pokedex pokemon pokemon-app typescript vue vue-cli vue-router vue-typescript vuex webapp

Last synced: 1 day ago
JSON representation

Pokèmon encyclopedia built using Vue.js and Typescript

Awesome Lists containing this project

README

        

# pokencyclopedia

[![Build Status](https://img.shields.io/badge/build-passing-brightgreen.svg)](https://img.shields.io/badge/build-passing-brightgreen.svg)
[![Netlify Status](https://api.netlify.com/api/v1/badges/bc7e8f42-711b-47b7-9c4e-85a31cef15f0/deploy-status)](https://app.netlify.com/sites/determined-mahavira-ffd5b1/deploys)
[![npm version](https://badge.fury.io/js/vue.svg)](https://badge.fury.io/js/vue)
[![npm version](https://badge.fury.io/js/typescript.svg)](https://badge.fury.io/js/typescript)
[![vue](https://img.shields.io/badge/build%20with-vue-blue.svg)](https://img.shields.io/badge/build%20with-vue-blue.svg)
![GitHub top language](https://img.shields.io/github/languages/top/dj0nny/pokencyclopedia)
[![typescript](https://img.shields.io/badge/types-Typescript-blue.svg)](https://img.shields.io/badge/types-Typescript-blue.svg)

> Pokèmon encyclopedia built using Vue.js

## Getting Started

### Prerequisites

For this project you need [__Node__](https://nodejs.org/en/) installed on your machine with [__Npm__](https://www.npmjs.com/) or [__Yarn__](https://yarnpkg.com)

### Installing

You can clone this repository using __Git__:
```bash
git clone https://github.com/dj0nny/pokencyclopedia.git
```

Or download the repository [here](https://github.com/dj0nny/pokencyclopedia/archive/develop.zip)

---

Open a terminal and type, inside the directory:
```bash
npm install
# OR
yarn install
```

for installing all the dependencies. At the end type, in the same folder:
```bash
npm run serve
# OR
yarn serve
```
for running the Vue.js development server. It will be up and running at this address: http://localhost:8080.

## Deployment

You can also create a build version of this repository running the command:
```bash
npm run build
# OR
yarn build
```
A deployed version is available on [Netlify](https://netlify.com) at this URL: https://determined-mahavira-ffd5b1.netlify.com/#/

## Built with ❤️ using:

* [Vue.js](https://vuejs.org/) - A Javascript framework
* [TypeScript](https://www.typescriptlang.org/) - Javascript based-type language
* [Vuex](https://vuex.vuejs.org/) - Centralized State Management for Vue.js
* [Pokedex-promise-v2 API](https://github.com/PokeAPI/pokedex-promise-v2) - An easy way to use [Pokeapi](https://pokeapi.co/) v2 with promises in Node.js
* [vue-property-decorator](https://github.com/kaorun343/vue-property-decorator) - Typescript decorators for Vue.js components
* [vuex-module-decorators](https://github.com/championswimmer/vuex-module-decorators) - Typescript decorators for Vuex modules

## Contributing

Pull Requests for adding features ⇄ and ★ are welcome 😎