https://github.com/guillainbisimwa/search-ror
A realtime search box, where users search articles, and then to have analytics that display what users were searching for.
https://github.com/guillainbisimwa/search-ror
redis rspec ruby-on-rails
Last synced: 7 months ago
JSON representation
A realtime search box, where users search articles, and then to have analytics that display what users were searching for.
- Host: GitHub
- URL: https://github.com/guillainbisimwa/search-ror
- Owner: guillainbisimwa
- Created: 2022-12-01T07:47:48.000Z (almost 3 years ago)
- Default Branch: development
- Last Pushed: 2022-12-14T16:10:55.000Z (almost 3 years ago)
- Last Synced: 2025-01-30T05:42:44.394Z (9 months ago)
- Topics: redis, rspec, ruby-on-rails
- Language: Ruby
- Homepage:
- Size: 424 KB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
Helpjuice Ruby on Rails Test project
A realtime search box, where users search articles, and then to have analytics that display what users were searching for.
Explore this project »
✧
Watch the Live Version ✧
Prerequisites ✧
Getting Started ✧
Usage ✧
Run tests ✧
Deployment ✧
Watch the Live Version ✧
Contributing ✧
Author ✧
Show your support ✧
Acknowledgments ✧
Report Bug ✧
Helpjuice Test project It's a web application with a good responsive design, built with Ruby on Rails
## Watch the Live Version
[Helpjuice Test project](https://pure-hamlet-90593.herokuapp.com/)
### Prerequisites
- Ruby 2.7.2 must be installed on your machine.
- Text Editor
- Rails 6.1.7
- Postgres: >=9.5
- Git
- End-to-End Testing with [RSpec](https://rspec.info/)
- Faker
- redis
- sidekiq
## Getting Started
1. Open Terminal.
2. Navigate to your desired location to download the contents of this repository.
3. Copy and paste the following code into the Terminal :
`git clone https://github.com/guillainbisimwa/Search-ror.git`
4. Run `cd Search-ror`
5. Install the needed dependencies `yarn install`
6. Install the needed gems `bundle install`
7. Next, create and migrate the database: `rails db:create` and `rails db:migrate RAILS_ENV=development`
8. run `rails server`
### Usage
To watch the local version of this project check on your browser for the link :
```
`http://localhost:3000/`
```
### Run tests
```
# rspec spec
```
### Deployment
To deploy this app to Heroku follow the steps below
Install the [Heroku CLI](https://devcenter.heroku.com/articles/heroku-cli)
After that type the command below into your teminal.
```
heroku create
```
```
git push heroku master
```
Finally, run the command to create your database Heroku
```
heroku run rails db:migrate
```
```
heroku run rails db:seed
```
## Contributing
This project was created as part of the Helpjuice test; contributing is accepted.
Feel free to check the [issues page](https://github.com/guillainbisimwa/Search-ror/issues).
## Author
👤 **Guillain Bisimwa**
- Github : [@guillainbisimwa](https://github.com/guillainbisimwa)
- Twitter : [@gullain_bisimwa](https://twitter.com/gullain_bisimwa)
- Linkedin : [guillain-bisimwa](https://www.linkedin.com/in/guillain-bisimwa-8a8b7a7b/)
### Show your support
Give a ⭐️ if you like this project!
## Acknowledgments
- [Helpjuice](https://helpjuice.com/)