Thoth1111 / LukApp

A real time search box with analytics to display what users searched for based on IP address

Geek Repo:Geek Repo

Github PK Tool:Github PK Tool

πŸ“— Table of Contents

LukApp

This project is a real time search box with analytics to display what users searched for based on IP address.

The main features of this website are:

  • Queries are logged in real time 500ms after a user stops typing and resolved (merged into one query) when submitted.
  • Incomplete queries, ie those saved before a submission are deleted if a user abandons the search and clears the input field.
  • Queries are stored based on IP address, so each quary is linked to the user this way. To avoid duplicate records, each query has a count property which is updated if an identical query is made.
  • Users can view a list of their previous queries listed in descending order from most popular to the least and the count for each query.
  • As a user types in the search box, suggestions are displayed below the search box from their previous searches.
  • The DOM is updated in real time when queries are made so the search history is updated immediately

πŸš€ Live Demo

Project Documentation πŸ“„

  • GitHub repository linkπŸ‘ˆ

Built With πŸ› οΈ

  • Programming Languages: Ruby, JavaScript.
  • Frameworks: Rails.
  • Database: PostgreSQL
  • Version-Control: Github
  • Code Editor: VS Code.

Getting Started

To get a local copy up and running follow these simple steps.

Prerequisites

  • Rails version 6 or above.
  • A code editor like Visual Studio Code.

Setup

Clone the repository using the GitHub link provided below.

Install

In the terminal, go to your file directory and run this command.

$ git clone https://Thoth1111/Fullstack-Capstone-Project.git

Usage

Run locally

Make your way to the correct directory by running this command:

$ cd LukApp

Install the required dependencies to run the project with this command:

$ bundle i

Then run it in your browser with this command:

rails s

Kindly modify the files as needed.

Run tests

To run tests, please run this command

rspec

(back to top)

Authors

πŸ‘€ Alwyn Androvelle

(back to top)

🀝 Contributing

Contributions, issues, and feature requests are welcome!

Feel free to check the issues page.

(back to top)

Show your support

Give a ⭐️ if you like this project!

Acknowledgments

  • Ideogram.AI for logo design

πŸ“ License

This project is MIT licensed.

(back to top)

About

A real time search box with analytics to display what users searched for based on IP address

License:MIT License


Languages

Language:Ruby 64.6%Language:HTML 13.1%Language:JavaScript 10.9%Language:Batchfile 5.0%Language:Dockerfile 3.6%Language:CSS 1.5%Language:Shell 1.2%