learnwithalfred/rails-real-time-search

Rails real time search app

RealTimeSearch

📗 Table of Contents

• 📗 Table of Contents
• 📖 Real Time Search
  • 🛠 Built With
    • Tech Stack
    • Key Features
  • 🚀 Live Demo
  • 💻 Getting Started
    • Prerequisites
    • Setup
    • Install
    • Usage
    • Run tests
  • 👥 Authors
  • 🤝 Contributing
  • ⭐️ Show your support
  • 📝 License

📖 Real Time Search

A realtime search box, where users search articles, and then to have analytics that display what users were searching for.

Real Time Search is a...

🛠 Built With

Tech Stack

Client

• HTML & CSS

Server

• Ruby on Rails

Database

• PostgreSQL

Key Features

• Create Articles
• Search Articles
• Read Search Results

🚀 Live Demo

• Live Demo Link

💻 Getting Started

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

Prerequisites

In order to run this project you need:

 gem install rails

Setup

Clone this repository to your desired folder:

  git clone https://github.com/learnwithalfred/rails-real-time-search

Install

Install this project with:

  cd rails-real-time-search
  gem install
  rails db:create && rails db:migrate && rails db:seed

Usage

To run the project, execute the following command:

  rails server

Run tests

To run tests, run the following command:

  rspec

👥 Authors

👤 Author1

• GitHub: @learnwithalfred
• Twitter: @kb_alfred
• LinkedIn: @learnwithalfred

🤝 Contributing

Contributions, issues, and feature requests are welcome!

Feel free to check the issues page.

⭐️ Show your support

Give a ⭐️ if you like this project!

📝 License

This project is MIT licensed.