https://github.com/michaeltelford/search_engine
Search engine built using Ruby and the Wgit gem
https://github.com/michaeltelford/search_engine
ruby search-engine sinatra slim wgit
Last synced: 12 months ago
JSON representation
Search engine built using Ruby and the Wgit gem
- Host: GitHub
- URL: https://github.com/michaeltelford/search_engine
- Owner: michaeltelford
- License: mit
- Created: 2017-05-29T20:10:53.000Z (about 9 years ago)
- Default Branch: master
- Last Pushed: 2024-07-10T13:07:16.000Z (almost 2 years ago)
- Last Synced: 2025-04-19T14:08:09.051Z (about 1 year ago)
- Topics: ruby, search-engine, sinatra, slim, wgit
- Language: Ruby
- Homepage: https://wgit-search-engine.fly.dev
- Size: 197 KB
- Stars: 0
- Watchers: 2
- Forks: 0
- Open Issues: 2
-
Metadata Files:
- Readme: README.md
- License: LICENSE.txt
Awesome Lists containing this project
README
# Search Engine
Search engine UI developed using:
- Ruby
- [wgit](https://github.com/michaeltelford/wgit) (search engine logic)
- Sinatra (web framework)
- Thin (templating engine)
Check out the demo search engine here:
```
https://wgit-search-engine.fly.dev
```
## Versioning
- `ruby-3.3.0`
### Assets
- `simplecss` -> Styling
- `font-awesome` -> Icons
See the `Gemfile` and `Gemfile.lock` files for gem versioning information.
## Dependencies
- A Javascript runtime e.g. [`node`](https://nodejs.org/en/)
## Usage
Start the app in development mode and open it in a browser with:
$ bundle exec rake browse
$ bundle exec rake serve # To manually open the URL yourself
See all the available rake tasks with:
$ bundle exec rake help
## Development
After checking out the repo, run `bin/setup` to install dependencies. Then, run `bundle exec rake test` to run the tests.
Run `bundle exec ./bin/console` for an interactive prompt that will allow you to experiment or you can call `byebug` anywhere in the code or tests to debug.
Github is used as the main code repository. Fly.io is used to deploy the demo app (URL above). To deploy, run `flyctl deploy` inside the root of the repo (once authenticated).
## Contributing
Bug reports and pull requests are welcome on GitHub at https://github.com/michaeltelford/search_engine.
## License
The website is available as open source under the terms of the [MIT License](http://opensource.org/licenses/MIT).