Real Time Search Tool

📗 Table of Contents

• 📗 Table of Contents
• 📖 [Real Time Search Box]
  • 🛠 Built With
    • Tech Stack
    • Key Features
  • 🚀 Live Demo
  • 💻 Getting Started
    • Prerequisites
    • Setup
    • Install
    • Usage
    • Run tests
    • Deployment
  • 👥 Authors
  • 🔭 Future Features
  • 🤝 Contributing
  • ⭐️ Show your support
  • 📝 License

📖 [Real Time Search Box]

This is a search tool or app built with ruby and rails. Its purpose is provide users with real time search results using various searching techniques to provide relevant results and also provide analytics on the most researched topics .

🛠 Built With

Tech Stack

Describe the tech stack and include only the relevant sections that apply to your project.

Client

• Embedded Ruby
• Tailwind

Server

• Rails

Database

• PostgreSQL

Key Features

-The application full text search and trigma search techniques to provide relevant search result. -For providing realtime search results the app utilizes hotwire and turbo stream to add autocomplete and provide better user experience

• Fast realtime search results
• Multiple search techniques
• Stores completed search queries for analytics

(back to top)

🚀 Live Demo

Coming Soon!

(back to top)

💻 Getting Started

You dont need much to get start. All you is an intermediate knowledge of Ruby on Rails

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

Prerequisites

In order to run this project you need:

Example command:

 gem install rails
 bundle install
 gem install pg_search and its extensions

Setup

Clone this repository to your desired folder:

Example commands:

  cd project directory
  git clone (https://github.com/admirerbrown/realtime-searchTool.git)

Install

Install this project with:

Example command:

  cd my-project
  gem install
  bundle install

Usage

To run the project, execute the following command:

Example command:

  ./bin/dev 

Run tests

To run tests, run the following command:

Example command:

  bin/rails test test/models/article_test.rb

Deployment

You can deploy this project using:

(back to top)

👥 Authors

Mention all of the collaborators of this project.

👤 SAMUEL KYERE

• GitHub: @admirebrown
• LinkedIn: samuel kyere

(back to top)

🔭 Future Features

Describe 1 - 3 features you will add to the project.

• Improve the frontend design
• Optimize database performance
• Add more advance searching techniques

(back to top)

🤝 Contributing

Contributions, issues, and feature requests are welcome!

Feel free to check the issues page.

(back to top)

⭐️ Show your support

feel free to improve or provide code review to the code base

(back to top)

(back to top)

(back to top)

📝 License

This project is MIT licensed.

NOTE: we recommend using the MIT license - you can set it up quickly by using templates available on GitHub. You can also use any other license if you wish.

(back to top)