Ecosyste.ms: Awesome

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

Awesome Lists | Featured Topics | Projects

https://github.com/k0ppai/search_analytics_engine

Search_Analytics_Engine is a Ruby on Rails test project given to me by Helpjuice. Main features include realtime instance search and popular searches analytics.
https://github.com/k0ppai/search_analytics_engine

rubyonrails stimulus

Last synced: 10 days ago
JSON representation

Search_Analytics_Engine is a Ruby on Rails test project given to me by Helpjuice. Main features include realtime instance search and popular searches analytics.

Awesome Lists containing this project

README

        


Search_Analytics_Engine



# 📗 Table of Contents

- [📖 About the Project](#about-project)
- [🛠 Built With](#built-with)
- [Tech Stack](#tech-stack)
- [🚀 Live Demo](#live-demo)
- [Key Features ](#key-features-)
- [💻 Getting Started](#getting-started)
- [Setup](#setup)
- [Prerequisites](#prerequisites)
- [Install](#install)
- [Usage](#usage)
- [Run tests](#run-tests)
- [👥 Authors](#authors)
- [🤝 Contributing](#contributing)
- [⭐️ Show your support](#support)
- [🙏 Acknowledgements](#acknowledgements)
- [📝 License](#license)

# 📖 [Search_Analytics_Engine]

**Search_Analytics_Engine** is a Ruby on Rails test project given to me by Helpjuice.

## 🛠 Built With

### Tech Stack

Server

Database

(back to top)

## 🚀 Live Demo

- Click this [link](https://search-enginee-ceb7b44283a9.herokuapp.com/) for live view.

(back to top)

### Key Features

This project supports the following features

- Realtime search features
- Popular searches analytics

(back to top)

## 💻 Getting Started

To get a local copy up and running, follow these steps.

### Prerequisites

In order to run this project you need the following installed locally:

- Ruby
- Rails
- PostgreSQL

### Setup

Clone this repository to your desired folder:

Example commands:

```sh
cd my-folder
git clone https://github.com/K0ppai/Search_Analytics_Engine.git
```

### Install

Install this project with:

```sh
bundle install
```

### Usage

To run the project, execute the following command and kindly set up for database in `database.yml` file:

```sh
rails s
```

### Run tests

To run tests, run the following command:

Example command:

```sh
rspec
```

(back to top)

## 👥 Authors

👤 **Paing Soe Thu**

- GitHub: [@K0ppai](https://github.com/K0ppai)
- Twitter: [link](https://twitter.com/_koppai_)
- LinkedIn: [LinkedIn](https://www.linkedin.com/in/paingsoe-thu/)

(back to top)

## 🤝 Contributing

Contributions, issues, and feature requests are welcome!

Feel free to check the [issues page](https://github.com/K0ppai/Search_Analytics_Engine/issues).

(back to top)

## ⭐️ Show your support

If you like this project, don't forget to give it a star. ⭐️

(back to top)

## 🙏 Acknowledgments

I would like to thank [Helpjuice](https://helpjuice.com/) for this amazing opportunity.

(back to top)

## 📝 License

This project is [MIT](https://github.com/K0ppai/Search_Analytics_Engine/blob/develop/LICENSE) licensed.

(back to top)