Code Monkey home page Code Monkey logo

pokedex's Introduction

Pokedex

A full-stack Pokédex implementation, using

  • FeathersJS (server)
  • VueJS (SPA client)
  • MongoDB (database)
  • Mongoose (MongoDB schemas)

screenshot

Prerequisites

Docker, or:

Node.js > 8.11.*

MongoDB 3.6.*

Installation

First clone this repository:

git clone https://github.com/wdmtech/pokedex

Running with Docker

docker-compose up

Then visit

http://localhost:8080

Running locally

to start the client:

cd client

npm install

npm run dev

to start the server:

cd server

npm install

npm run start

Evaluation

To inspect the database, I recommend using Robo 3T

Connect to the database using localhost:27017

Possible improvements following MVP

  • Add authentication, allowing for multiple users
  • Add notifications and messages for adding/deleting properties (added!)
  • Validate inputs for better UX, better user communication
  • Implement image upload for new Pokémon
  • Improve UI
  • Restrict types and weaknesses to those that don't exist for a given Pokémon
  • Add tooltips (e.g. when the user hovers over the Pokémon, indicating that they may favourite it)
  • Refactor Pokemon component into smaller, reusable components
  • Add tests for hooks, and UI elements

Copyright and licensing

The software is licensed under the MIT license. See the LICENSE file for full copyright and license text. The short version is that you can do what you like with the code, as long as you say where you got it.

This repository includes data extracted from the Pokémon series of video games.

All of it is the intellectual property of Nintendo, Creatures, inc., and GAME FREAK, inc. and is protected by various copyrights and trademarks. The author believes that the use of this intellectual property for a fan reference is covered by fair use — the use is inherently educational, and the software would be severely impaired without the copyrighted material.

That said, any use of this library and its included data is at your own legal risk.

pokedex's People

Contributors

wdmtech avatar

Watchers

 avatar  avatar

pokedex's Issues

Pokémon - View

View Pokémon data in a "card" with the following information:

  • The name (mandatory: a single word between 4 and 24 characters)
  • Brief description (mandatory: minimum 30 characters)
  • Type(s): a Pokémon has a maximum of two types and at least one (see schema definition in #1 )
  • Evolutions: Pokémon into which it evolves (optional, eg: bellsprout evolves in weepinbell)

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    🖖 Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. 📊📈🎉

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google ❤️ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.