/hj-search

HJ search is a full-stack web app. A search engine which is a real time search box where users search articles and then the search engine records and displays analytics about what users searched the most, number of times they searched a particular query and other information.

Primary LanguageRuby

Hj search

📗 Table of Contents

📖 [Hj search]

HJ search is a full-stack web app. A search engine which is a real time search box where users search articles and then the search engine records and displays analytics about what users searched the most, number of times they searched a particular query and other information. In addition, users can read the article that they are searching for. This software can be integral part of any platform as it mimics a knowledge-base software. A stop center for anyone looking for solutions either a customer or an internal organisation employee.

Quick Preview

image

🛠 Built With

Tech Stack

Client
  • Hotwire
  • CSS
  • ERB
Server
  • PUMA
Backend
  • Ruby on Rails
Database
  • Postgresql

Key Features

  • Real time article search
  • search analytics
  • Article show

(back to top)

🚀 Live Demo

[Not yet deployed]

(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:

  • Ruby 3.0.0
  • Rails 7
  • PostgreSQL 12
  • Node

Setup

Clone this repository to your desired folder:

  cd my-folder
  git clone git@github.com:BertrandConxy/hj-search.git

Install

Install this project with:

  cd hj-search
  bundle install

Usage

Play with the code

rails c

Populate the database with dummy data

rails db:migrate
rails db:seed

Start rails server(Puma)

$ rails server
 - Open [http://localhost:3000/](http://localhost:3000/) in your browser

Run linters

rubocop -A

Run tests

$ rspec spec
  - this will run all the test cases
$ rspec spec/folder_name/name_of_test_file.rb
  - to run test cases individually

👥 Authors

👤 Bertrand Mutangana Ishimwe

(back to top)

🔭 Future Features

  • Recent searches
  • Article listing based on analytics
  • Advanced analytics

(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 don't hesitate to give it a star 😎

(back to top)

🙏 Acknowledgments

  • I would like to thank Microverse
  • I would like to thank helpjuice for giving me this assignment

(back to top)

📝 License

This project is MIT licensed.

(back to top)