HJ Search engine

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.

Quick Preview

Live Demo

Demo

Built with

• Ruby
• Ruby on Rails
• Rubocop
• Bootstrap
• Gems
  • Rspec
  • Faker
  • FuzzyStringMatch

Get Started

Follow these steps below:

Pre-requisites

- Ruby 3.0.0
- Rails 7
- PostgreSQL 12

Setup

Clone the repo and run bundle install in the command line to install the dependencies

$ git clone https://github.com/BertrandConxy/search-engine.git
$ cd search-engine

Install gems with:

$ bundle install

Play with the code

rails c

Populate the database with dummy data

rails db:migrate
rails db:seed

Run linters

rubocop -A

Run test on project with

$ rspec
  - this will run all the test cases

$ rspec spec/folder_name/name_of_test_file.rb
  - to run test cases individually

Start rails server (puma)

$ rails server

Open http://localhost:3000/ in your browser

Author

👤 Bertrand Mutangana Ishimwe

• GitHub: @BertrandConxy
• Twitter: @Bconxy
• LinkedIn: Bertrand Mutangana Ishimwe

🤝 Contributing

Contributions, issues, and feature requests are welcome!

Feel free to check the issues page.

Show your support

Give a ⭐️ if you like this project!

Acknowledgments

• Original design idea by Google

📝 License

This project is MIT licensed.