Files
pokedex/README.md
2024-01-15 11:05:39 -05:00

77 lines
2.1 KiB
Markdown

<a name="readme-top"></a>
<br />
<div align="center">
[![LinkedIn][linkedin-logo]][linkedin-url]
<a href="https://github.com/xyvs/pokedex">
<img src="images/logo.png" width="80" height="80">
</a>
<h3 align="center">pokedexyvs</h3>
![Vue][vue-logo]
![Tailwind][tailwind-logo]
![Vercel][vercel-logo]
<p align="center">
And very stylish pokedex web app made with Vue.js and TailwindCSS.
<br />
<a href="https://pokedex.xyvs.io"><strong>View Demo »</strong></a>
</p>
</div>
<!-- ABOUT THE PROJECT -->
## About The Project
[![][product-screenshot]](https://pokedex.xyvs.io)
This a pokedex web app made with Vue.js, it's using the [PokeApi](https://pokeapi.co/) to get the data, it's inspired this design on [Dribbble](https://dribbble.com/shots/2859891--025-Pikachu) and it's also deployed on [Vercel](https://vercel.com/).
<p align="right">(<a href="#readme-top">back to top</a>)</p>
<!-- GETTING STARTED -->
## Getting Started
This is how to set up your project locally and get a local copy up and running.
### Installation
1. Clone the repo
```sh
git clone https://github.com/xyvs/pokedex
```
2. Install NPM packages
```sh
npm install
```
3. Run the dev enviroment
```js
npm run dev
```
4. Go to `http://localhost:3000` and enjoy!
<p align="right">(<a href="#readme-top">back to top</a>)</p>
<!-- LICENSE -->
## License
Distributed under the MIT License.
<p align="right">(<a href="#readme-top">back to top</a>)</p>
<!-- MARKDOWN LINKS & IMAGES -->
<!-- https://www.markdownguide.org/basic-syntax/#reference-style-links -->
[product-screenshot]: images/screenshot.png
[linkedin-logo]: https://img.shields.io/badge/-LinkedIn-black.svg?style=for-the-badge&logo=linkedin
[linkedin-url]: https://www.linkedin.com/in/jofranmtz/
[vue-logo]: https://img.shields.io/badge/Vue-black?style=for-the-badge&logo=vuedotjs&logoColor=fff
[tailwind-logo]: https://img.shields.io/badge/Tailwind-black?style=for-the-badge&logo=tailwindcss&logoColor=fff
[vercel-logo]: https://img.shields.io/badge/Vercel-black?style=for-the-badge&logo=vercel&logoColor=fff