https://github.com/rizerkrof/keiko

https://github.com/rizerkrof/keiko

Last synced: 24 days ago
JSON representation

• Host: GitHub
• URL: https://github.com/rizerkrof/keiko
• Owner: rizerkrof
• Created: 2023-01-30T15:00:41.000Z (almost 2 years ago)
• Default Branch: main
• Last Pushed: 2023-02-02T13:34:52.000Z (almost 2 years ago)
• Last Synced: 2023-05-25T19:28:22.493Z (over 1 year ago)
• Language: TypeScript
• Size: 884 KB
• Stars: 0
• Watchers: 1
• Forks: 0
• Open Issues: 6
• Metadata Files:
  • Readme: README.md

Awesome Lists containing this project

README

        
# Keiko Pokemon

## Prerequisites

- `NodeJS` v14+ installed

- `yarn` installed globally (`npm install -g yarn`)

## Installation

Install the backend dependencies:

```bash

cd backend && yarn

```

Install the frontend dependencies

```bash

cd frontend && yarn

```

You are good to go !

## Running the project

- Open two different terminals (one for the backend and the other the frontend)

- In the first terminal, start the backend by running:

```bash

cd backend && yarn start

```

Check that the backend is running by visiting: [http://localhost:8000](http://localhost:8000). A website should appear with some API docs.

- In the second terminal, start the frontend by running:

```bash

cd frontend && yarn start

```

Check that the frontend is running by visiting: [http://localhost:3000](http://localhost:3000).

## Development

This project supports hot reloading. Each time a file is modified in the frontend, the server will automatically reload the required code.