{"id":27944804,"url":"https://github.com/codehass/realtimesearchbox","last_synced_at":"2025-07-11T17:33:38.583Z","repository":{"id":287033260,"uuid":"963155843","full_name":"codehass/realtimeSearchBox","owner":"codehass","description":"Realtime Search Box is an application designed to provide analytics on user search behavior, specifically focusing on the most popular articles and search queries.","archived":false,"fork":false,"pushed_at":"2025-05-02T23:31:37.000Z","size":98,"stargazers_count":0,"open_issues_count":5,"forks_count":0,"subscribers_count":1,"default_branch":"main","last_synced_at":"2025-05-07T12:54:41.731Z","etag":null,"topics":[],"latest_commit_sha":null,"homepage":"https://realtime-search-box-acjg.onrender.com/","language":"Ruby","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":null,"status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/codehass.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":null,"code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null,"zenodo":null}},"created_at":"2025-04-09T08:41:08.000Z","updated_at":"2025-04-11T09:19:42.000Z","dependencies_parsed_at":null,"dependency_job_id":"88f5cd60-bd54-482f-90c7-607a7633b6df","html_url":"https://github.com/codehass/realtimeSearchBox","commit_stats":null,"previous_names":["codehass/realtimesearchbox"],"tags_count":0,"template":false,"template_full_name":null,"purl":"pkg:github/codehass/realtimeSearchBox","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/codehass%2FrealtimeSearchBox","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/codehass%2FrealtimeSearchBox/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/codehass%2FrealtimeSearchBox/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/codehass%2FrealtimeSearchBox/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/codehass","download_url":"https://codeload.github.com/codehass/realtimeSearchBox/tar.gz/refs/heads/main","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/codehass%2FrealtimeSearchBox/sbom","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":264862354,"owners_count":23674947,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":[],"created_at":"2025-05-07T12:54:33.199Z","updated_at":"2025-07-11T17:33:38.578Z","avatar_url":"https://github.com/codehass.png","language":"Ruby","readme":"\u003c!-- TABLE OF CONTENTS --\u003e\n\n# 📗 Table of Contents\n\n- [📗 Table of Contents](#-table-of-contents)\n- [📖 Realtime Search Box](#-realtime-search-box-)\n  - [🛠 Built With](#-built-with-)\n    - [Tech Stack](#tech-stack-)\n    - [Key Features](#key-features-)\n  - [💻 Getting Started](#-getting-started-)\n    - [Prerequisites](#prerequisites)\n    - [Setup](#setup)\n    - [Usage](#usage)\n    - [Run tests](#run-tests)\n  - [👥 Authors](#-authors-)\n  - [🔭 Future Features](#-future-features-)\n  - [🤝 Contributing](#-contributing-)\n  - [⭐️ Show Your Support](#️-show-your-support-)\n  - [🙏 Acknowledgments](#-acknowledgments-)\n  - [📝 License](#-license-)\n\n\u003c!-- PROJECT DESCRIPTION --\u003e\n\n# 📖 Realtime Search Box \u003ca name=\"about-project\"\u003e\u003c/a\u003e\n\n**Realtime Search Box** is an application designed to provide analytics on user search behavior, specifically focusing on the most popular articles and search queries.\n\n## 🛠 Built With \u003ca name=\"built-with\"\u003e\u003c/a\u003e\n\n### Tech Stack \u003ca name=\"tech-stack\"\u003e\u003c/a\u003e\n  - **Ruby on Rails**: Primarily a backend framework, but it also handles front-end views with Embedded Ruby (ERB) templates..\n  - **Postgresql**: The database used to store user data and search queries.\n\n### Key Features \u003ca name=\"key-features\"\u003e\u003c/a\u003e\n- **Search for articles**: Users can search for articles, and the system keeps track of those searches.\n- **Get statistics about searched queries**: The system provides analytics on popular search queries and trends.\n\n## Home \n\u003cp align=\"right\"\u003e(\u003ca href=\"#readme-top\"\u003eback to top\u003c/a\u003e)\u003c/p\u003e\n\n\u003c!-- GETTING STARTED --\u003e\n\n## 💻 Getting Started \u003ca name=\"getting-started\"\u003e\u003c/a\u003e\n\n### Prerequisites\n\nTo run this app locally, you need to have the following installed on your system:\n\n- **A code editor** (e.g., VS Code, Sublime Text)\n- **A browser** (e.g., Chrome, Firefox)\n- **Node.js**: For managing JavaScript dependencies.\n- **Ruby**: Ensure you have Ruby installed (version 3.4.2).\n- **Rails**: Install Rails to run the application (version Rails 8.0.2).\n\n### Setup\n\nTo get a local copy up and running, follow these steps:\n\n1. **Clone the repository**:\n    ```bash\n    git clone git@github.com:codehass/realtimeSearchBox.git\n    ```\n\n2. **Install dependencies**:\n    ```bash\n    bundle install\n    ```\n\n3. **Set up the database**:\n    ```bash\n    rails db:create db:migrate\n    ```\n\n4. **Seed the database** (optional, if you want some sample data):\n    ```bash\n    rails db:seed\n    ```\n\n5. **Start the Rails server**:\n    ```bash\n    rails s\n    ```\n\n    This will run the server locally. You can access the application at `http://localhost:3000`.\n\n### Usage\n\nOnce the server is running, you can:\n- Visit `http://localhost:3000/articles` to see the list of articles.\n- Use the search functionality to search for articles and view search statistics.\n\n\u003cp align=\"right\"\u003e(\u003ca href=\"#readme-top\"\u003eback to top\u003c/a\u003e)\u003c/p\u003e\n\n## 👥 Authors \u003ca name=\"authors\"\u003e\u003c/a\u003e\n\n👤 **Hassan EL OUARDY**\n\n- GitHub: [@codehass](https://github.com/codehass)\n- Twitter: [@hassanelourdy](https://twitter.com/hassanelourdy)\n- LinkedIn: [Hassan El OUARDY](https://www.linkedin.com/in/hassan-el-ouardy-360b99169/)\n\n\u003cp align=\"right\"\u003e(\u003ca href=\"#readme-top\"\u003eback to top\u003c/a\u003e)\u003c/p\u003e\n\n\u003c!-- FUTURE FEATURES --\u003e\n\n## 🔭 Future Features \u003ca name=\"future-features\"\u003e\u003c/a\u003e\n- **User authentication**: Allow users to sign up, log in, and track their search history.\n- **Advanced search filtering**: Provide filters to refine article search results.\n- **Admin panel**: Implement an admin interface to manage articles and view more detailed analytics.\n\n\u003cp align=\"right\"\u003e(\u003ca href=\"#readme-top\"\u003eback to top\u003c/a\u003e)\u003c/p\u003e\n\n\u003c!-- CONTRIBUTING --\u003e\n\n## 🤝 Contributing \u003ca name=\"contributing\"\u003e\u003c/a\u003e\n\nContributions are always welcome! Please feel free to fork the repository, make improvements, and create a pull request. \n\nTo contribute:\n1. Fork the repo.\n2. Create a branch (`git checkout -b feature-name`).\n3. Make your changes.\n4. Commit your changes (`git commit -m 'Add some feature'`).\n5. Push to the branch (`git push origin feature-name`).\n6. Open a pull request.\n\n\u003cp align=\"right\"\u003e(\u003ca href=\"#readme-top\"\u003eback to top\u003c/a\u003e)\u003c/p\u003e\n\n## ⭐️ Show Your Support \u003ca name=\"support\"\u003e\u003c/a\u003e\n\nIf you like this project, kindly leave a ⭐ star on the repository!\n\n\u003cp align=\"right\"\u003e(\u003ca href=\"#readme-top\"\u003eback to top\u003c/a\u003e)\u003c/p\u003e\n\n## 🙏 Acknowledgments \u003ca name=\"acknowledgments\"\u003e\u003c/a\u003e\n\nI would like to thank **Microverse** for the great resources shared throughout the course.\n\n\u003cp align=\"right\"\u003e(\u003ca href=\"#readme-top\"\u003eback to top\u003c/a\u003e)\u003c/p\u003e\n\n## 📝 License \u003ca name=\"license\"\u003e\u003c/a\u003e\n\nThis project is licensed under the [MIT License](./LICENSE).\n\n\u003cp align=\"right\"\u003e(\u003ca href=\"#readme-top\"\u003eback to top\u003c/a\u003e)\u003c/p\u003e\n","funding_links":[],"categories":[],"sub_categories":[],"project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fcodehass%2Frealtimesearchbox","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fcodehass%2Frealtimesearchbox","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fcodehass%2Frealtimesearchbox/lists"}