darikmohammed / search

📗 Table of Contents

• 📖 About the Project
  • 🛠 Built With
    • Tech Stack
    • Key Features
  • 🚀 Live Demo
• 💻 Getting Started
  • Setup
  • Prerequisites
  • Install
  • Usage
  • Run tests
• 👥 Authors
• 🤝 Contributing
• 🙏 Acknowledgements
• 📝 License

📖 Realtime search box- Helpjuice

A real-time search box, where users search articles, and then have analytics that displays what users were searching for. Show a record of user input in real-time

🛠 Built With

Tech Stack

Built-in with Ruby on Rails

Client

• html.erb
• Tailwind CSS

Server

• Rails

Database

• PostgreSQL

Key Features

Real-time search box and analytics of user searching.

• [Realtime Searching]
• [Show record of user input]
• [Compare the search that is made in the past 30 min]
• [Check the similarity of the search before updating using A collection of text algorithms]

(back to top)

🚀 Live Demo

• Render Live Demo Link

(back to top)

💻 Getting Started

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

Prerequisites

To run this project you need:

 gem install rails

Setup

Clone this repository to your desired folder:

  git clone [e-mail]:darikmohammed/search.git

Install

Install this project with:

  cd search
  bundle install
  rails db:setup
  rails db:seed

Usage

To run the project, execute the following command:

  rails server

Run tests

To run tests, run the following command:

  bundle exec rspec 

👥 Authors

👤 Darik Mohammed

• GitHub:
• Twitter:
• LinkedIn:

(back to top)

🤝 Contributing

Contributions, issues, and feature requests are welcome!

Feel free to check the issues page.

(back to top)

🙏 Acknowledgments

I would like to to thank

• Helpjuice
• Emil Hajric

(back to top)

📝 License

This project is MIT licensed.

(back to top)