TYPEAHEAD REST API

GitHub Repository

Overview

Custom Typeahead API, powered by Node.js, Express.js, TypeScript, and MySQL, simplifies location data retrieval within the United States via req.params. Streamlined for company-specific needs, it offers fast, accurate, and scalable location search functionality, enhancing user experiences for internal applications.

Installation

You can install the dependencies with the following command:

npm install

Configuration

Create a .env file in the root of your project and add the following environment variables with their respective values:

PORT=       # The port on which the API should run
DB_HOST=    # The hostname for your MySQL database
USER=       # The username for connecting to your MySQL database
PASSWORD=   # The password for the MySQL user

Run development mode

You can run the project in development mode:

npm run dev

Run testing

You can run the project in testing mode:

npm run test