Git Product home page Git Product logo

pokemon-wiki's Introduction

pokemon-wiki

Description

pokemon-wiki is a mini wiki that allows users to search for concise data about the pokemon they want. Design is heavily inspired by Bulbapedia XD.

Live page accessible at https://jovanwongzixi.github.io/pokemon-wiki/

Utilised github action workflow with build-test-deploy CI/CD to automate deployment to github-pages

Tech Used

  • VueJS
  • HTML/CSS
  • Vitest
  • Axios

Recommended IDE Setup

VSCode + Volar (and disable Vetur) + TypeScript Vue Plugin (Volar).

Customize configuration

See Vite Configuration Reference.

Download project

git clone https://github.com/jovanwongzixi/pokemon-wiki.git
cd pokemon-wiki

Project Setup

npm install

Compile and Hot-Reload for Development

npm run dev

Compile and Minify for Production

npm run build

Run Unit Tests with Vitest

npm run test:unit

Run Test Coverage

npm run coverage

Design Considerations

Interface Design

Concise and clear

Being a small scale wiki, the goal should be to provide concise information in a simple aesthetic for user to process easily and quickly. Hence, I only chose to display information that are more important.

Different colour background used in PokemonCard for easy recognition of Pokemon primary type

Screen width of different devices

Although this wiki was designed primarily for desktop viewing, I used @media(min-width: ) in CSS to adjust the layout for body and PokemonCard component. PokemonCard is only rendered as a grid with 2 columns when the screen width is wide enough

Code Design

Utilising Components

Application was designed to be based on components, with PokemonCard being the 'parent' component that contain multiple 'child' components(Pokemon attributes). I attempted to follow the Open-Closed Principle used in Object Oriented Programming, where PokemonCard component should be open for extension(integrating more sub-components easily) but closed for modification(logic for existing sub-components can remain the same).

Initially, I used a BasicComponent for all sub-components that did not require special design and similar rendering format so future components can be added without having to code a new component from scratch. However, that meant that more preprocessing of information retrieved from API has to be done in PokemonCard, which made the code look even more cluttered. Changes to information in existing sub-components will have to be made in PokemonCard which seemed unintuitive to me.

pokemon-wiki's People

Contributors

jovanwongzixi avatar

Watchers

 avatar

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.