Zven94/Article-Searcher-API

Search-Engine | Project

📗 Table of Contents

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

---

Search-Engine

"Search-Engine" is a searcher web app like google application to search everything you want. This project is a JS Vanilla application, and it allows users to register and log in with their credentials, see all the items registered, and add or delete items to the inventory.

Two repositories were created for its construction:

• A backend repository with an API built with the Ruby on Rails Framework with a PostgreSQL database.
• A frontend repository with a React/Redux Toolkit application from which the created API is consumed.

Additionally, the API documentation is available here.

---

---

🛠 Built With

Tech Stack

The project is built using the following technologies:

• Ruby on Rails.
• PostgreSQL.
• RSpec.
• Rubocop.

---

Key Features

• Differents repos: This help to split and manage responsibilities.
• On going search: The user can write and the search is trigger it automatically.
• User-Friendly Interface: Navigate with ease.
• Analytics tab: The API return you the 10 most searched terms.

• Ruby on Rails
• Linters
  • Rubocop
• Follow list of Rails and JS best practices

(back to top)

🚀 Live Demo

• 🎤 Project presentation: video demo
• Live Demo Link

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

• Installed Ruby and Ruby on Rails.
• If you're using Windows, have installed WSL.
• If you're using MacOS, an option is using UTM.

Setup

To clone this repository to your desired folder, run the following command:

git clone https://github.com/Zven94/Article-Searcher.git

Navigate to the cloned repository and run the following command to install the necessary gems:

cd Article-Searcher
bundle install

Before continue you will need to create your own credentials file. To do so, first remove config/master.key and config/credentials.yml.enc if they exist.

run the following command:

EDITOR=code rails credentials:edit 

You can close the editor that opens. This command will create a new master.key and credentials.yml.enc if they do not exist. Now you can continue.

Usage

Initialize it with

rails server

Then open http://localhost:3000 in your browser.

Now you need to create the database, run the following command:

rails db:create

Then migrate the database:

rails db:migrate

Test

To run the tests try the following command:

rspec spec

(back to top)

---

👥 Authors

👤 Nicolas Bolañez

• GitHub: @Zven94
• LinkedIn: Nico

(back to top)

---

🔭 Future Features

Upcoming improvements:

• More analytics about searched data.
• Responsive desing for moviles and tablets.

(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 and know someone who might find it helpful, please share it. Or give it a star ⭐️

(back to top)

---

🙏 Acknowledgments

I thank Microverse for this fantastic opportunity, and the code reviewers for their advice and time.

Original design idea by Emil Hajric.

(back to top)

---

📝 License

This project is MIT licensed.

(back to top)

---