ElsonOtake/search_engine

Search engine is a real-time articles search box. Have analytics that displays what users were searching.

📗 Table of Contents

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

📖 Blog

Search engine is a real-time articles search box. Have analytics that displays what users were searching.

🛠 Built With

Tech Stack

Client

• Stimulus

Server

• Ruby on Rails
• Sass
• RSpec Rails
• Capybara

Database

• PostgreSQL

Key Features

• REST API
• Stimulus
• Tests
• API documentation

(back to top)

🚀 Live Demo

• Live Demo Link

• API documentation

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

Ruby

Setup

Clone this repository to your desired folder:

using HTTPS:

  git clone https://github.com/ElsonOtake/Search_Engine.git
  cd Search_Engine

using an SSH key:

  https://github.com/ElsonOtake/search_engine.git
  cd Search_Engine

using GitHub CLI:

  git clone gh repo clone ElsonOtake/Search_Engine
  cd Search_Engine

Install

Install this project with:

  bundle install
  rails db:create db:migrate db:seed

Usage

To run the project, execute the following command:

  rails server

Open http://localhost:3000/ on your browser.

Run tests

To run tests, run the following command:

  rspec spec/features
  rspec spec/models
  rspec spec/requests

To generate the API documentation:

  rake rswag

API documentation address.

(back to top)

👥 Author

👤 Elson Otake

• GitHub: elsonotake
• Twitter: @elsonotake
• LinkedIn: elsonotake

(back to top)

🔭 Future Features

• Create admin user to assess general data

(back to top)

🤝 Contributing

Contributions, issues, and feature requests are welcome!

Feel free to check the issues page.

(back to top)

⭐️ Show your support

Give a ⭐️ if you like this project!

(back to top)

🙏 Acknowledgments

I would like to thank:

• Microverse
• W3Schools
• Stack Overflow
• Helpjuice

(back to top)

📝 License

This project is MIT licensed.

(back to top)