MosDevx / FindersKeepers

The Search Engine of the Future !

📗 Table of Contents

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

📖 [FindersKeepers]

[FindersKeepers] is a search engine application that allows users to search for popular articles.

🛠 Built With

Tech Stack

• Ruby
• Ruby On Rails
• PostgreSQL
• Redis

Key Features

• [Query an Articles Repository]
• [Cache Queries for Speedy retrieval]
• [Provide Metric On User Queries(metrics consolidated after 3 minutes)]

(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 in your local system

• Ruby
• Git CLI
• Redis
• Github account

Setup

Clone this repository to your desired folder:

  cd my-folder
  git clone https://github.com/MosDevx/FindersKeepers.git

Install

Install this project with:

  cd blog_app
  bundle install

Usage

To run the project, execute the following command:

  ruby main.rb

Run tests

• Type Rspec: To run test `
• Type npx stylelint "**/*.{css,scss}" to run for stylelint errors

(back to top)

👥 Authors

👤 Moses Wamae

• GitHub: @Moses Wamae
• Twitter: @Moses Wamae
• LinkedIn: @Moses Wamae

(back to top)

🔭 Future Features

• [Enhanced Search Functionality]
• [User Authentication]

(back to top)

🤝 Contributing

Contributions, issues, and feature requests are welcome!

Feel free to check the issues page.

(back to top)

⭐️ Show your support

If you like this project please leave a STAR to the Github repo

(back to top)

🙏 Acknowledgments

I would like to appreciate Helpjuice for providing the chance and impetus to develop this application and grow my code-fu.

(back to top)

📝 License

This project is MIT licensed.

(back to top)