Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/onjoseph/realtime_search_box
This project is a realtime search box that shows analytics on whats people searched for the most.
https://github.com/onjoseph/realtime_search_box
postgresql rails ruby ruby-on-rails stimulusjs turboframe vanilla-js
Last synced: 17 days ago
JSON representation
This project is a realtime search box that shows analytics on whats people searched for the most.
- Host: GitHub
- URL: https://github.com/onjoseph/realtime_search_box
- Owner: ONJoseph
- License: mit
- Created: 2024-01-13T13:20:20.000Z (12 months ago)
- Default Branch: master
- Last Pushed: 2024-01-14T08:08:46.000Z (12 months ago)
- Last Synced: 2024-10-23T13:45:37.655Z (2 months ago)
- Topics: postgresql, rails, ruby, ruby-on-rails, stimulusjs, turboframe, vanilla-js
- Language: Ruby
- Homepage: https://github.com/ONJoseph/realtime_search_box
- Size: 48.8 KB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# Real-time Search box
> This project is a realtime search box that shows analytics on whats people searched for the most.
## Note
This project is realtime search box built with `Vanilla JS`, `ruby on rails` and `Turbo_Frames` to manage the realtime page load features connected with `Stimulus Js`.
## Live Link
[Live Link](https://mysite-l9h8.onrender.com/)
## Built With
- Ruby on Rails
- Vanilla JS
- Turbo_frames
- Postgresql
- stimulus
## Getting Started
To get a local copy up and running follow these simple steps:
```sh
git clone https://github.com/ONJoseph/realtime_search_box.git
cd realtime_search_box
```
### Prerequisites
Before starting make sure that you have the following runing on your computer
- `Ruby 3.2.2`
- `Rails 7.1.2`
- `PostgresSQL`
### Setup
Install gems with:
```sh
bundle install
```
Create a file `.env` in the root of your project directory to store your database name and the password.
```sh
touch .env
```
`.env` file content
```ruby
DB_USERNAME=your_database_name
DB_PASSWORD=your_database_password
```
Setup database
```sh
rails db:setup
rails db:migrate
rails db:seed
```
Start server
```sh
rails server
```
Open [http://localhost:3000/](http://localhost:3000/]) in your browser.
### Run tests
```
bundle exec rspec
```
## Authors
👤 **Joseph Ogbole**
- GitHub: [@ONJoseph](https://github.com/ONJoseph)
- Twitter: [@ONJoseph1](https://twitter.com/ONJoseph1)
- LinkedIn: [LinkedIn](https://www.linkedin.com/in/o-n-joseph-ba8425147/)
## 🤝 Contributing
Contributions, issues, and feature requests are welcome!
Feel free to check the [issues page](https://github.com/ONJoseph/realtime_search_box/issues).
## Show your support
Give a ⭐️ if you like this project!
## Acknowledgments
- Shoutout to Helpjuice, Google and ChatGPT!
## 📝 License
This project is [MIT](./LICENSE) licensed.