项目作者: kitharvey

项目描述 :
Pokédex app in card style. Swipe through pokemon cards or guess who's that pokemon?.
高级语言: TypeScript
项目地址: git://github.com/kitharvey/pokenex.git
创建时间: 2021-04-10T12:01:21Z
项目社区:https://github.com/kitharvey/pokenex

开源协议:

下载




pokémon logo

Pokénex




Pokédex app in card style. Swipe through pokemon cards or guess who’s that pokemon?.


Explore the docs »




View Demo
·
Report Bug
·
Request Feature
·
How it’s made?



Table of Contents


  1. About The Project



  2. Getting Started


  3. Roadmap

  4. Contact





About The Project

Pokenex Screenshot

There are many great pokédex apps online but I found most of them are similarly built, displayed in a grid, scroll and click a pokémon to view more details about it. So I build my own but in a different style.

No mobile version yet.

Features:

  • Swipe pokémon cards to explore
  • Add to favorites
  • Play “who’s that pokémon?”
  • Climb the leaderboard

Of course, I will be adding more soon or you can request a feature.




Built With




Getting Started

To get a local copy up and running follow these simple example steps.

Prerequisites

This is an example of how to list things you need to use the software and how to install them.

  • yarn
    1. npm install --global yarn

Installation

  1. Clone the repo
    1. git clone https://github.com/kitharvey/pokenex.git
  2. Go to project directory
    1. cd pokenex
  3. Install NPM packages
    1. yarn
  4. Create MongoDB, set up your database and copy MONGODB_URI
  5. Create Github-OAuth and copy client ID and secrets
  6. Create .env file and add URI and keys
    1. MONGODB_URI = "xxxxxxxxxxxxxxxxxxxxxxxx"
    2. GITHUB_CLIENT_ID = "xxxxxxxxxxxxxxxxxxxxxxxx"
    3. GITHUB_CLIENT_SECRET = "xxxxxxxxxxxxxxxxxxxxxxxx"
    4. AUTH_SECRET = "xxxxxxxxxxxxxxxxxxxxxxxx"
    5. JWT_SECRET = "xxxxxxxxxxxxxxxxxxxxxxxx"
    6. JWT_SIGNING_PRIVATE_KEY = "xxxxxxxxxxxxxxxxxxxxxxxx"
    7. NEXTAUTH_URL = "http://localhost:3000/"
  7. Start the application in your localhost
    1. yarn dev



Roadmap

This project is still under development.




Contact

Kit Harvey - linkedIn

Project Link: https://github.com/kitharvey/pokenex