This README covers instructions for setting up the environment, running tests, and starting the app locally.
Please ensure the following are installed on your machine:
-
Clone the Repository
git clone https://github.com/your-username/your-repository.git cd your-repository
-
Install Dependencies
Use Yarn to install the necessary packages:
yarn install
-
Set Environment Variables
The app requires the
REACT_APP_RAPID_API_KEY
environment variable to function correctly. Create a.env
file in the root directory of the project and add the following:REACT_APP_RAPID_API_KEY=<SECRET_KEY_HERE>
To verify the app's behavior, run the tests using:
yarn test
![image](https://private-user-images.githubusercontent.com/13429481/340890324-b9a618ba-98c8-4ded-bba9-da978796f4d0.png?jwt=eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJpc3MiOiJnaXRodWIuY29tIiwiYXVkIjoicmF3LmdpdGh1YnVzZXJjb250ZW50LmNvbSIsImtleSI6ImtleTUiLCJleHAiOjE3MjU1OTEzNjYsIm5iZiI6MTcyNTU5MTA2NiwicGF0aCI6Ii8xMzQyOTQ4MS8zNDA4OTAzMjQtYjlhNjE4YmEtOThjOC00ZGVkLWJiYTktZGE5Nzg3OTZmNGQwLnBuZz9YLUFtei1BbGdvcml0aG09QVdTNC1ITUFDLVNIQTI1NiZYLUFtei1DcmVkZW50aWFsPUFLSUFWQ09EWUxTQTUzUFFLNFpBJTJGMjAyNDA5MDYlMkZ1cy1lYXN0LTElMkZzMyUyRmF3czRfcmVxdWVzdCZYLUFtei1EYXRlPTIwMjQwOTA2VDAyNTEwNlomWC1BbXotRXhwaXJlcz0zMDAmWC1BbXotU2lnbmF0dXJlPTdiMGFiYTY0YmQwNDI3ODhmZDZmMzk4M2NkYTc4ZDgxYjYyMTg2ZmIzNmUwOTZlNjRjYWIyYWYxOTQ4YzA1NzcmWC1BbXotU2lnbmVkSGVhZGVycz1ob3N0JmFjdG9yX2lkPTAma2V5X2lkPTAmcmVwb19pZD0wIn0.Cj1mQkyrAbEBRR50dXP4WW3gonhzK1ticilXvLawtCU)
To start the application locally, run:
yarn start
The app will launch on http://localhost:3000. You can access it via your web browser.
The preview of the widget!