ubdanam / search-engine-analytics

The project aims to deliver a real-time search feature allowing users to search articles. This web app will capture and analyze user search queries, enabling the generation of insightful analytics without the need for extensive user authentication methods like Devise.

Search Engine Analytics

📗 Table of Contents

• 📖 About the Project
  • 🛠 Built With
    • Tech Stack
    • Key Features
  • 🚀 Live Demo
• 💻 Getting Started
  • Prerequisites
  • Setup
  • Install
  • Usage
• 👥 Authors
• 🔭 Future Features
• 🤝 Contribution
• ⭐️ Show your support
• 🙏 Acknowledgements
• 📝 License

📖 Search Engine Analytics

Hi there! Welcome to the Search Engine Analytics project

The project aims to deliver a real-time search feature allowing users to search articles. This web app will capture and analyze user search queries, enabling the generation of insightful analytics without the need for extensive user authentication methods like Devise. The focus lies not only on the search functionality but also on the comprehensive analytics and trends derived from user interactions. By tracking searches in real-time, the goal is to present meaningful insights into the most frequently searched topics, enhancing the overall understanding of user behavior and preferences.

🛠 Built With

Tech Stack

Client

• CSS
• Vanilla JavaScript

Server

• Ruby on Rails

Key Features

• Real-time search functionality
• Debounced search for better performance
• SQL query sanitization to secure app from SQL injection attacks
• Recent search activities page
• Use Levenshtein distance algorithm to summarize complete search
• IP tracking for search queries
• User-friendly search Interface
• Real-time user input recording
• Comprehensive search analytics
• Real-time filtering articles

(back to top)

🚀 Live Demo

• Live Demo Link

(back to top)

💻 Getting Started

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

Prerequisites

In order to run this project you need to install the following:

• Ruby
• PostgreSQL
• Rails gem

Setup

Clone this repository to your desired folder:

  git clone https://github.com/UbdaNam/search-engine-analytics.git

Install

  bundle install

Install this project with: Any code editor or terminal which you are comfortable with

Usage

In the project directory, you can run:

rails db:create

rails db:migrate
rails db:migrate RAILS_ENV=test

rails db:seed

rails s

rspec spec

👥 Author

👤 Ubda Nam

• GitHub: @UbdaNam
• LinkedIn: Abdurahim M.

Future Features

• Add charts for visually apealing search trends
• Navigations

(back to top)

🤝 Contribution

Contributions, issues, and feature requests are welcome!

Feel free to check the issues page.

(back to top)

⭐ Show your support

If you like this project please give it a ⭐. If you have any recommandations for future improvments, I would be happy to hear them.

(back to top)

🙏 Acknowledgments

• This project is built based on given instructions by (Confidential)

(back to top)

📝 License

This project is MIT licensed.