📗 Table of Contents

• 📖 About the Project
  • 🛠 Built With
    • Tech Stack
    • Key Features
  • 🚀 Live Demo
• 💻 Getting Started
  • Setup
  • Prerequisites
  • Install
  • Usage
  • Run tests
  • Deployment
• 👥 Authors
• 🔭 Future Features
• 🤝 Contributing
• ⭐️ Show your support
• 🙏 Acknowledgements
• ❓ FAQ
• 📝 License

📖 SEARCH ENGINE

SEARCH ENGINE is a realtime search box, where users search articles, and have analytics that display what users were searching for.

🛠 Built With

Tech Stack

Mainly Ruby on Rails with StimulusJS and turbo frame.

Framework/Libraries

• StimuusJS
• Turbo Frame
• Tail Wind CSS
• Devise
• CanCanCan
• Rspec

Bundler

• Webpack
• JS Bundling Gem

Client

• HTML
• CSS

Server

• Ruby on Rails' WEBrick
• Ruby on Rails' Puma

Database

• PostgreSQL

Key Features

• It records input in real time
• It displays analytics & trends of what you search for
• It sorts resources in ascending and descending order
• It authenticates user
• User authorization is configured

(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:

• Node
• Ruby
• PostgreSQL
• Rails
• Rbenv
• NPM
• Yarn
• Rspec

Setup

Clone this repository to your desired folder:

cd <the name of folder you want to clone this project into>
git clone git@github.com:Gambit142/Search-Engine-App.git
cd Search-Engine-App

Install

Install this project with:

bundle install
yarn install

Database creation

Next, use this command to create the databases:

rails db:create

Run Migrations

Next, use this command to run the migration files:

rails db:migrate

Run Seed Data

Next, use this command to run seed data:

rails db:migrate

Run Rspec Tests

rspec spec

Usage

To run the project, execute the following command:

./bin/dev

(back to top)

👥 Authors

Click on my social links to contact me for work and collaboration.

👤 Author

• GitHub: @Gambit142
• LinkedIn: LinkedIn

(back to top)

🔭 Future Features

• Add more resources that can be queried
• Implement Pagination for resources
• Display more metrics

(back to top)

🤝 Contributing

Contributions, issues, and feature requests are welcome!

Feel free to check the issues page.

(back to top)

📝 License

This project is MIT licensed.

(back to top)