https://github.com/datswissguy/pokemon-app

Angular SPA to browse Pokémon. Consumes the PokéApi RESTful API. Work in progress...
https://github.com/datswissguy/pokemon-app

angular pokeapi pokemon rest-api rest-client single-page-app typescript

Last synced: about 1 month ago
JSON representation

Angular SPA to browse Pokémon. Consumes the PokéApi RESTful API. Work in progress...

• Host: GitHub
• URL: https://github.com/datswissguy/pokemon-app
• Owner: DatSwissGuy
• License: mit
• Created: 2020-09-02T17:12:10.000Z (almost 6 years ago)
• Default Branch: master
• Last Pushed: 2021-05-22T21:23:42.000Z (about 5 years ago)
• Last Synced: 2025-03-03T12:16:03.813Z (over 1 year ago)
• Topics: angular, pokeapi, pokemon, rest-api, rest-client, single-page-app, typescript
• Language: TypeScript
• Homepage:
• Size: 5.76 MB
• Stars: 1
• Watchers: 2
• Forks: 0
• Open Issues: 8
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

          
![Firebase Deployment](https://github.com/DatSwissGuy/pokemon-app/workflows/Firebase%20Deployment/badge.svg?branch=master)

![Docker-Compose Build](https://github.com/DatSwissGuy/pokemon-app/workflows/Docker-Compose%20Build/badge.svg?branch=master)

---

![PokeNgLogo](doc/PokeNg.png)

# Purpose

Building an (simple) Angular SPA for Browsing Pokémon. Consumes the [PokéAPI](https://www.pokeapi.co) RESTful API. And no, it's not a Pokédex, i might create one someday.

# Screenshots / Progress

![Progress-2020-9-13](doc/Screenshot_2020-12-08.png)

*(September 2020) Initial design / layout for the app, showing the first 151 Pokémon*

Features:

- Docker Compose setup (September 2020)

- SSR (September 2020)

- Initial PWA functionality (02.01.2021)

- A list of Pokémon from each generation can be selected (19.01.2021)

- Automatic deployment via `GitHub Actions` (19.01.2021)

- List of games up to fith generation (22.01.2021)

- Route transition animations (26.01.2021)

# Demo

This app is currently hosted on Google Firebase. Server Side Rendering is realized via Firebase Functions. [Have a look](https://pokemon-app-51156.web.app).

# Installing / Running the App

Clone the repo. Then run `npm install` to install dependencies, after that run `ng serve` to serve the app. 

Alternatively if you have Docker, run `docker-compose up --build` to build and then serve the app on ` localhost:4000`.

# WIPs

This list is in no particular order / respectively prioritized.

- This readme needs some work 😅

- The Docker Compose badge only shows that the build was successful. No information regarding tests.

- Tests for CD / CI

- A design for the app, it currentyl looks a bit uninspiring.