An open API service indexing awesome lists of open source software.

https://github.com/ichala/helpengine

HelpEngine is a realtime search box, where users search articles, and then to have analytics that display what users were searching for
https://github.com/ichala/helpengine

postgres rails search-engine

Last synced: 2 months ago
JSON representation

HelpEngine is a realtime search box, where users search articles, and then to have analytics that display what users were searching for

Awesome Lists containing this project

README

        


GitHub forks

# HelpEngine

> HelpEngine is a realtime search box, where users search articles, and then to have analytics that display what users were searching for

![MOCK](https://user-images.githubusercontent.com/89282221/206560999-409ca06a-9d47-4f59-a13e-da488e04448d.jpg)

## Table of Contents

* [Installation](#installation)
* [Tools](#tools)
* [Testing](#testing)
* [Live Demo & Screenshots](#live-demo)
* [Authors](#authors)

## Installation
- https://github.com/ichala/HelpEngine.git
- cd HelpEngine
- bundle install
- create .env based on .env.example & Add necessary credentials
- rails db:setup db:migrate db:seed
- rails s

## Tools

- Ruby On Rails v7.0
- Boostrap v5.0
- Postgres
- rspec

## Testing

- run rails db:migrate RAILS_ENV=test
- run rspec

## Live Demo

Coming Soon

## Authors

👤 **Ali Jendoubi**

- GitHub: [@ichala](https://github.com/ichala)
- Twitter: [@_ichala](https://twitter.com/_ichala)
- LinkedIn: [@alijendoubi](https://www.linkedin.com/in/alijendoubi/)

## Show your support

Give a ⭐️ if you like this project!

## 📝 License

This project is MIT licensed.