MikeBurton89/yanchware_challenge_platform

Simple application for digital nomads that want to search for a new city

Yanchware Challenge

This application is built using Vite and React, and it is a simple web application that allows users to search for a new city. More extensive documentation can be found here

Installation

To install the application's dependencies, you need to have Node.js installed on your machine. You can download Node.js from here. Once node is installed, you can clone the repository and run the following commands:

npm install or yarn

Running the application

To run the application, you can run the following command:

npm run dev or yarn dev

Building the application

To build the application, you can run the following command:

npm run build or yarn build

Testing the application

To test the application, you can run the following command:

npm run test or yarn test

Notes

• The application is built using Vite and React.
• The application uses TypeScript.
• The application is tested using Vitest and React Testing Library.
• The appliction uses Material Ui as a design system.
• The application uses mocked data that are present in 2 json files to mock API calls since there's no api present at the moment.
• The application is deployed on Vercel and can be accessed here.