desorgui/search-real-time

Search Real Time

View Demo · Documentation · Report Bug · Request Feature

📗 Table of Contents

• 📖 About the Project
  • 🛠 Built With
    • Key Features
  • 🚀 Live Demo
• 💻 Getting Started
  • Setup
  • ‼️ Prerequisites
  • Usage
• 👥 Authors

• 🤝 Contributing
• ⭐️ Show your support
• 🙏 Acknowledgements

• 📝 License

📖 [search-real-time]

[search-real-time] a full-stack web application using Ruby on Rails and plain CSS.

• Integrated the Devise gem for user authentication to ensure secure access to the application.
• Implemented efficient search functionality using Jarowrinkler and PgSearch to provide accurate and relevant search results for users.
• Utilized Turbo Frame Tag, Stimulus, and Hotwire to improve the user experience by providing real-time updates and avoiding full-page reloads.
• Included an analytics feature that lists the most searched terms by users to help them refine their searches accordingly.

🛠 Built With

Tech and Languages

• CSS
• Javascript
• Ruby
• Ruby on Rails
• Postgres
• Devise

Server

• Ruby on Rails

Database

• PostgreSQL

🎯 Key Features

• [Real time search]
• [Record user search]
• [Show user search history]

(back to top)

🚀 Live Demo

• Real time search 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:

• Git
• Node JS
• ruby
• rails
• A code Editor (VS Code, Sublime Text, ...)

Setup

Clone this repository to your desired folder:

Open Git Bash and run:

  cd my-folder
  git clone https://github.com/desorgui/search-real-time.git
  cd search-real-time

⚙️ Install

Install this project with:

 gem install bundler
 bundler install

👀 Usage

To run the project locally, follow these steps:

• In the terminal run: rails s, that will run the server.

• and Open the http://localhost:3000 in your browser.

🧪 Run tests

To run unit and integration tests, run the following on the root project's directory:

Run rspec spec

To run Rubocop tests, run the following command:

Run rubocop --color

(back to top)

👥 Authors

👤 Guishny DESOR

• GitHub: @desorgui
• Twitter: @DGuishny
• LinkedIn: Guishny Desor

(back to top)

🤝 Contributing

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 ⭐️.

(back to top)

🙏 Acknowledgments

• Special Thanks to everyone who will get time to check this code and suggest any issues.

(back to top)

📝 License

This project is MIT licensed.

(back to top)