https://github.com/fene-87/realtime_search
I create a real-time search box, where users search articles, and then show analytics that display what users were searching for.
https://github.com/fene-87/realtime_search
Last synced: 6 months ago
JSON representation
I create a real-time search box, where users search articles, and then show analytics that display what users were searching for.
- Host: GitHub
- URL: https://github.com/fene-87/realtime_search
- Owner: Fene-87
- License: mit
- Created: 2024-01-21T00:23:55.000Z (over 1 year ago)
- Default Branch: dev
- Last Pushed: 2024-01-21T09:01:52.000Z (over 1 year ago)
- Last Synced: 2025-04-07T15:13:39.118Z (6 months ago)
- Language: Ruby
- Size: 68.4 KB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# Helpjuice Realtime SearchBox & Analytics
# 📗 Table of Contents
- [🛠 Built With ](#-built-with-)
- [Tech Stack ](#tech-stack-)
- [Key Features ](#key-features-)
- [🚀 Live Demo](#live-demo)
- [💻 Getting Started ](#-getting-started-)
- [Prerequisites](#prerequisites)
- [Setup](#setup)
- [Install](#install)
- [Usage](#usage)
- [👥 Author ](#-author-)
- [🤝 Contributing ](#-contributing-)
- [⭐️ Show your support ](#️-show-your-support-)
- [🙏 Acknowledgments ](#-acknowledgments-)
- [📝 License ](#-license-)
This is a ruby on rails realtime searchbox that enables users to search for articles. It then provides analytics for what users were searching for and the top searches. Input is recorded in realtime.
To access the search bar, navigate to the main page. As you type your query into the search box, suggestions based on your input will appear in real time below the search box. You can click on any of the suggestions to autofill the search box. Press enter to execute the search.
There is a dedicated analytics page which is accessed by clicking on the analytics link. This presents data on the most common search queries. This data is also updated in real time.
- **[Real-time searchbox]**
- **[Search analytics]**
Click on the link to view the app.
- [Live Demo](https://helpjuice-mra5.onrender.com/)
To get a local copy up and running, follow these steps.
### Prerequisites
In order to run this project you need:
- Ruby
- Rails
### SetUp
Clone this Repository to your desired folder:
``` sh
cd my-folder
git clone git@github.com:Fene-87/helpjuice_test.git
```
### Install
Install this project with:
``` sh
bundle install
```
### Usage
To run the project, execute the following command:
``` sh
bundle exec rails server
```
## 👥 Author
👤 **Mark Fenekayas**
- GitHub: [@Fene-87](https://github.com/Fene-87)
- LinkedIn: [@Mark Fenekayas](https://www.linkedin.com/in/mark-fenekayas/)
Contributions, issues, and feature requests are welcome!
Feel free to check the [issues page](../../issues/).
If you like this project consider giving it a star ⭐️.
I would like to thank Emil Hajric, CEO Helpjuice, for granting me this opportunity to work on this project which has been a great and enlightening learning experience.
This project is [MIT](./LICENSE) licensed.