https://github.com/renatoosaka/pokedex

https://github.com/renatoosaka/pokedex

Last synced: about 1 month ago
JSON representation

• Host: GitHub
• URL: https://github.com/renatoosaka/pokedex
• Owner: renatoosaka
• Created: 2024-08-23T20:17:21.000Z (5 months ago)
• Default Branch: main
• Last Pushed: 2024-08-25T13:35:46.000Z (5 months ago)
• Last Synced: 2024-08-25T15:48:06.260Z (5 months ago)
• Language: TypeScript
• Size: 323 KB
• Stars: 0
• Watchers: 1
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md

Awesome Lists containing this project

README

        
# Pokédex

This repository is a template for a Pokédex application. It contains a server-side

REST API built using [NestJS](https://nestjs.com) and a client-side single-page

application built in [Angular](https://angular.dev).

## Prerequisites

- [Node.js v20](https://nodejs.org/en)

## Setup

1. Clone the repository.

2. Install dependencies:

   ```shell

   cd /path/to/cloned/pokedex/

   cd api/

   npm install

   cd ../app/

   npm install

   ```

## Run

In two separate shells, start the API and app:

```shell

cd api/

npm run start

```

```shell

cd app/

npm run start

```

Both the API and app will rebuild as changes are made to them.

## Docker

To run the project with docker.

```shell

docker compose build

docker compose up

```

- to access the front end http://localhost:8080

- to access the backend http://localhost:300/swagger

## Tests

To run the tests on both the frontend and backend

```shell

yarn test:e2e

```