Skip to content

tthheusalmeida/pokedex

Repository files navigation

Pokedex

Pokedex is a personal project to train some Vue js fundamentals and plugins.

License: MIT

📂 Table of Contents

📖 About

Pokedex is a high-tech portable encyclopedia used in the pokemon world.

Pokemons are like the animals that live in that world.

It is possible to obtain various information about pokemons, such as weight, height, abilities, among others.

The idea is to implement or simulate the one that already exists, using oficial API the PokeApi.

💡 Technology

The project was developed with the following technologies:

  • Vuejs The Progressive JavaScript Framework
  • Vue Cli is a Standard Tooling for Vue.js Development
  • Vuetify is a Vue UI Library with beautifully handcrafted Material Components
  • Vuex is a state management pattern and library for Vue.js applications
  • ESLint statically analyzes your code to quickly find problems
  • Lodash a modern JavaScript utility library delivering modularity, performance & extras.
  • Jest is a delightful JavaScript Testing Framework with a focus on simplicity
  • HighCharts for create interactive charts easily for your web projects.
  • Vercel combines the best developer experience with an obsessive focus on end-user performance.

📸 In Action

📱 Mobile

🖥️ Desktop

🏁 Getting Started

The project is hosted at the following address https://pokedex-phi-six.vercel.app/.

As it can also be used locally with the steps below.

⚙️ Project setup

First clone the project:

git clone [email protected]:tthheusalmeida/pokedex.git

Use the command to install the dependencies

npm install

Run the project

npm run serve

After the above process is over, go to http://localhost:8080/ on the browser.

Enjoy!

Other Commands

Compiles and minifies for production

npm run build

Run your unit tests

npm run test:unit

Lints and fixes files

npm run lint

😃 How to contribute

  • First, I leave ⭐ if you liked it!
  • Fork this repository.
  • Create a branch with the features: git checkout -b my-feature
  • Commit: git commit -m 'feat: My new feature'
  • Submit your branch: git push origin my-feature

📝 License

This project is under the MIT license. see the license page for more details.

Made with ❤️ by Matheus Almeida