gdsrosa / search-app-deel

A Search application with Autocomplete features.

Search App Deel

A Search application with Autocomplete features. You can find the deployed version of this app at this link.

Getting Started

These instructions will get you a copy of the project up and running on your local machine for development and testing purposes, to do so clone this repo:

git clone https://github.com/gdsrosa/search-app-deel.git
cd search-app-deel

Installing

Assuming you have all the Node.js (20+) and NPM (version 10+) environment setup in your machine:

Let's install the dependencies

npm install

Setup env vars

To make sure you have all the env vars configured on your side, please go to .env file and add the API endpoint. Note: It is encouraged to create a .env.local file and execute the same step.

  # on the .env
  VITE_API_ENDPOINT=https://661d327ee7b95ad7fa6c7d8b.mockapi.io/api/users

Running the application in development mode

To start your local dev-server run:

npm run dev

Running the tests

To execute the unit tests:

npm test

Built With

• Typescript - The programming language used for the Client
• React.js - The UI library used for the Client
• NPM - Dependency Management
• CSS - Styles Management
• Vite - Frontend Tooling
• Vitest - JavaScript Unit Test tool

Authors

• Gabriel Rosa - gdsrosa