PawPrint

Fetch wonderful pictures of cute doggos 🐶🐶🐶.

This project is built using Vite and uses React and Typescript. You can see it live on https://paw-print.netlify.app/.

Table of Contents

• Installation
• Running the App
  • Development Mode
  • Production Build
• Testing
  • Unit
  • End to End
• Known issues

Installation

1. Clone the repository:

git clone git@github.com:pxlmvr/pawprint.git

2. Install dependencies:

cd pawprint
npm install

Running the app

Development Mode

To run the app in development mode:

npm run dev

By default views are on http://127.0.0.1:5173/

Production Build

To create a production build of the app:

npm run build

This will generate an optimized build in the dist directory.

Testing

Unit

We use Jest for running unit tests. To execute unit tests:

npm run test

End to End

We use Cypress for End to end testing. To run e2e tests in headless mode:

npm run dev
npm run e2e:headless

Note: this command assumes you have Chrome installed on your machine.

Alternatively if you want to run tests through Cypress' UI run:

npm run dev
npm run e2e

Known issues

If you are running node v.20.6.0 you could run into the following error while running the app in development mode:

[plugin:vite:react-babel] Cannot redefine property: File

It's recommended to use the latest lts version of node to get rid of the issue.