Skip to content

Commit

Permalink
UPDATE README
Browse files Browse the repository at this point in the history
  • Loading branch information
WilianMorales committed Jun 14, 2023
1 parent e4af23d commit fc5723d
Show file tree
Hide file tree
Showing 3 changed files with 29 additions and 14 deletions.
43 changes: 29 additions & 14 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,27 +1,42 @@
<div align="center">
<img width="500px" src="https://raw.githubusercontent.com/WilianMorales/pokedex-App/main/src/assets/images/pokereu.jpg">
</div>

# Pokedex

This project was generated with [Angular CLI](https://github.com/angular/angular-cli) version 12.2.18.

## Development server

Run `ng serve` for a dev server. Navigate to `http://localhost:4200/`. The app will automatically reload if you change any of the source files.

## Code scaffolding
### DEMO: [App Pokedex](https://ng-pokedev.netlify.app/)

Run `ng generate component component-name` to generate a new component. You can also use `ng generate directive|pipe|service|class|guard|interface|enum|module`.
# Functionalities

## Build
- [x] Responsive Design
- [x] List all Pokémon of all generations
- [x] Show information about pokemons and their evolutions
- [x] filter the data of the pokemon according to its evolutions
- [ ] Search for a pokemon
- [ ] Filter pokemon according to its type
- [ ] Change the mode of the image using a SlideToggle
- [ ] Add pokemon to favorites

Run `ng build` to build the project. The build artifacts will be stored in the `dist/` directory.
## Responsive

## Running unit tests
![Design preview for Mobile](./mobile-preview.png)

Run `ng test` to execute the unit tests via [Karma](https://karma-runner.github.io).
![Design preview for Desktop](./desktop-preview.png)

## Running end-to-end tests
### The following API was used:

Run `ng e2e` to execute the end-to-end tests via a platform of your choice. To use this command, you need to first add a package that implements end-to-end testing capabilities.
> PokeAPI --> https://pokeapi.co/
## Further help
## Implemented Dependencies:
* ngx-toastr
```
npm i ngx-toastr
```

To get more help on the Angular CLI use `ng help` or go check out the [Angular CLI Overview and Command Reference](https://angular.io/cli) page.
## Note:
### Install dependencies for running this project
```
npm install
```
Binary file added desktop-preview.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added mobile-preview.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.

0 comments on commit fc5723d

Please sign in to comment.