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

https://github.com/r17x/warpokex


https://github.com/r17x/warpokex

graphql javascript pokede pokemon react react-apollo react-hook

Last synced: 4 months ago
JSON representation

Awesome Lists containing this project

README

          

# Warpokex
[![codecov](https://codecov.io/gh/ri7nz/TokFractions/branch/master/graph/badge.svg)](https://codecov.io/gh/ri7nz/Warpokex)
[![Maintainability](https://api.codeclimate.com/v1/badges/1671a8db78546109d010/maintainability)](https://codeclimate.com/github/ri7nz/Warpokex/maintainability)
[![Build Status](https://travis-ci.org/ri7nz/Warpokex.svg?branch=master)](https://travis-ci.org/ri7nz/Warpokex)
[![GitHub license](https://img.shields.io/badge/license-MIT-blue.svg)](https://ri7nz.mit-license.org/)

### Live Demo : [Warpokex Live Here](https://warpokex.ri7nz.now.sh/) deployed in [Now.sh](http://now.sh)

This project was bootstrapped with [Create React App](https://github.com/facebook/create-react-app).

## Prerequisite
- Make sure [Node](https://nodejs.org/en/) & [Yarn](https://yarnpkg.com/lang/en/docs/install) or [NPM](https://docs.npmjs.com/downloading-and-installing-node-js-and-npm) has installed in your local machine.
- You need clone this project `$ git clone git@github.com:ri7nz/Warpokex.git `.
- Change directory & Install dependencies `$ cd Warpokex && yarn install`.
- Let's Check the [Available Scripts](https://github.com/ri7nz/Warpokex#available-scripts).

Note: I'm using `Yarn`.

## What I use ?
- [React.js](http://reactjs.org) (bootstrapped by [create-react-app](https://github.com/facebook/create-react-app))
- [PokeDex Graphql](https://graphql-pokemon.now.sh/) by [@lucasbento](https://github.com/lucasbento/graphql-pokemon)
- [Jest](http://jestjs.io/) (built-in in create-react-app)
- [Jest-Each](https://www.npmjs.com/package/jest-each) (Tool For Jest & Testing)
- [@testing-library/react](https://github.com/testing-library/react-testing-library) (For Test React Component)
- [@testing-library/jest-dom](https://github.com/testing-library/jest-dom) (Jest Custom Matcher)
- [Zeit/now](https://zeit.co/) (For Deployment & Service Integration)
- [Dependabot](https://github.com/apps/dependabot-preview) (Dependencies secure and up to date)
- [CodeCov](https://codecov.io/gh/ri7nz/Warpokex) (Code Coverage & Service Integration)

## Available Scripts

In the project directory, you can run:

### `yarn start`

Runs the app in the development mode.

Open [http://localhost:3000](http://localhost:3000) to view it in the browser.

The page will reload if you make edits.

You will also see any lint errors in the console.

### `yarn test`

Launches the test runner in the interactive watch mode.

See the section about [running tests](https://facebook.github.io/create-react-app/docs/running-tests) for more information.

### `yarn test:ci`

Use for CI like `travis` for testing and integration with codecov (coverage test).

### `yarn test:lint`

For test format, style & lint code with `Eslint`.

### `yarn lint`

Running `test:lint` for fix issue of code.

### `yarn build`

Builds the app for production to the `build` folder.

It correctly bundles React in production mode and optimizes the build for the best performance.

The build is minified and the filenames include the hashes.

Your app is ready to be deployed!

See the section about [deployment](https://facebook.github.io/create-react-app/docs/deployment) for more information.

## Credits

Warpokex [MIT license](https://ri7nz.mit-license.org/).