This is a search tool or app built with ruby and rails. Its purpose is provide users with real time search results using various searching techniques to provide relevant results and also provide analytics on the most researched topics .
Describe the tech stack and include only the relevant sections that apply to your project.
Client
Server
Database
-The application full text search and trigma search techniques to provide relevant search result. -For providing realtime search results the app utilizes hotwire and turbo stream to add autocomplete and provide better user experience
- Fast realtime search results
- Multiple search techniques
- Stores completed search queries for analytics
Coming Soon!
You dont need much to get start. All you is an intermediate knowledge of Ruby on Rails
To get a local copy up and running, follow these steps.
In order to run this project you need:
Example command:
gem install rails
bundle install
gem install pg_search and its extensionsClone this repository to your desired folder:
Example commands:
cd project directory
git clone (https://github.com/admirerbrown/realtime-searchTool.git)Install this project with:
Example command:
cd my-project
gem install
bundle installTo run the project, execute the following command:
Example command:
./bin/dev To run tests, run the following command:
Example command:
bin/rails test test/models/article_test.rbYou can deploy this project using:
Mention all of the collaborators of this project.
👤 SAMUEL KYERE
- GitHub: @admirebrown
- LinkedIn: samuel kyere
Describe 1 - 3 features you will add to the project.
- Improve the frontend design
- Optimize database performance
- Add more advance searching techniques
Contributions, issues, and feature requests are welcome!
Feel free to check the issues page.
feel free to improve or provide code review to the code base
This project is MIT licensed.
NOTE: we recommend using the MIT license - you can set it up quickly by using templates available on GitHub. You can also use any other license if you wish.