faizrktm / my-pokemon

SPA Pokedex built on top React (Typescript), Emotion and Graphql.

Home Page:https://pokebag.vercel.app

Geek Repo:Geek Repo

Github PK Tool:Github PK Tool

Pokebag APP

Web Based Single Page Application of Pokemon Library to catch and safe it to your own bag.

Demo available at: https://pokebag.vercel.app

Getting Started

These instructions will get you a copy of the project up and running on your local machine for development and testing purposes. See deployment for notes on how to deploy the project on a live system.

Prerequisites

Make sure you already have yarn or npm installed on your machine. If not, please take a look at this link below.

https://classic.yarnpkg.com/en/docs/install

Installing

After that, install required dependencies by executing this command on terminal

yarn install
# or
npm install

After instalation success, run command below to make your code available in development mode.

yarn start

Open http://localhost:3000 to see the website

Development

We are using git flow for development purpose. Please use this prefix for branches on spesific use case of development

1. feature/branch_name

Checkout from branch develop and create feature/branch_name for creating new feature.

2. hotfix/branch_name

Checkout from branch master and create hotfix/branch_name for creating hotfix or immediate fix on production.

Running on production

Kindly use this command to build app for production and serve it.

yarn build && yarn start

Open http://localhost:3000 to see the website

Testing

This project contain unit testing and integration testing. All the test files have *.test.js name. To launch test runner in interactive watch mode for current uncommit codes, run

yarn test

To watch all test and see coverage run

yarn test --coverage --watchAll

Deployment

For this project we are using Vercel because it is easy and support Create React App project. It has built in CI/CD to detect changes/merge on default branch to create new build.

Built With

Authors

  • Faiz Azmi Rekatama - Initial work - faizrktm

About

SPA Pokedex built on top React (Typescript), Emotion and Graphql.

https://pokebag.vercel.app


Languages

Language:TypeScript 85.6%Language:JavaScript 10.8%Language:HTML 3.4%Language:CSS 0.2%