https://github.com/abeidahmed/cuddly-octo-enigma
https://github.com/abeidahmed/cuddly-octo-enigma
Last synced: 3 months ago
JSON representation
- Host: GitHub
- URL: https://github.com/abeidahmed/cuddly-octo-enigma
- Owner: abeidahmed
- Created: 2021-04-12T04:57:16.000Z (about 4 years ago)
- Default Branch: main
- Last Pushed: 2021-04-14T05:09:09.000Z (about 4 years ago)
- Last Synced: 2025-01-06T07:45:34.636Z (5 months ago)
- Language: Ruby
- Homepage: https://live-knowledge.herokuapp.com/
- Size: 1.17 MB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# Knowledge base app
## Live demo
[Click here](https://live-knowledge.herokuapp.com/)
## Getting started
- `git clone https://github.com/abeidahmed/cuddly-octo-enigma.git`
- `bundle install` and `yarn install`
- Setup your db: `rails db:create db:migrate`. You may need to setup the `database.yml` file
- Run `rails s` and `ruby ./bin/webpack-dev-server` to start the server
- Visit `localhost:3000`
## Testing
Run `bundle exec rspec` to run all the tests
## Tech stack used
- Rails
- Stimulus
- TailwindCSS
- PostgreSQL
## Why I didn't use redis to store the suggestions
This project is hosted at Heroku (free version) and when I tried to install
the `heroku redis`, it asked me to verify my Credit Card. I would have
verified it without any issue, but I do not have one.
## Main feature (Live intelligent search)
I debounced the `user input` so as to not hit the database for every
keystroke. However, this solution is not full-proof. For example: You wanted to
query `how are you?`, but you type `how are` and wait for one second and then
you type `you?` to complete the sentence. Now you have two suggestions:
- `how are` and,
- `how are you?`
As you can see, the first suggestion is pretty baseless as it does not provide
any context whatsoever.
### Solution
In the backend, I run a simple sentence checker which intelligently checks
for the previous sentence (`how are`) and the incoming sentence (`how are you?`)
and then decides which one to keep and which one to discard.
It also works for typos:
- `Howis my friend?`
- `How is my friend?`
The last one is stored to the db in this case.
## Contact
- GitHub: [@abeidahmed](https://github.com/abeidahmed)
- Twitter: [@iamhawaabi](https://twitter.com/iamhawaabi)
- LinkedIn: [Abeid Ahmed](https://www.linkedin.com/in/abeidahmed/)