sophiabrandt / opinion-ate

TDD React Outside-In

opinion-ate

An app for tracking reviews of dishes at different restaurants.

Note: this project is from the book Outside-In React Development with some changes made by me:

• it uses Typescript instead of JavaScript
• I tried to replace some of the deprecated API for Redux with more modern variants from Redux Toolkit, e.g. createAsyncThunk
• form handling via custom hook and uncontrolled form input

Getting Started

These instructions will get you a copy of the project up and running on your local machine for development and testing purposes. See deployment for notes on how to deploy the project on a live system.

Prerequisites

• bun
• Node.js

Installing

Install dependencies:

bun install

You will need an API key for the backend server. Check https://api.outsidein.dev/ for further information.

Create a new file called .env.local and add the key:

VITE_API_KEY=

Running the tests

Unit Tests

This project uses vitest and React Testing Library.

bun test:run

Or use watch mode:

bun test:watch

E2E Tests

This project uses Cypress for end-to-end-testing.

bun cy:run

or

bun cy:open

Deployment

tbd

Built With

• React
• Vite

License

As the code is mostly from the aforementioned book, I cannot release this code with an open license. ¯\_(ツ)_/¯

Contributing

Please read CONTRIBUTING.md for details on our code of conduct, and the process for submitting pull requests to us.

Acknowledgments

• Hat tip to CodingItWrong