Helpjuice Test Project: Realtime Search Box

📗 Table of Contents

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

📖 [Helpjuice Test Project: Realtime Search Box]

Rails backend API powers our Realtime Search Analytics. It seamlessly handles user searches, IP tracking, and data analytics. Efficient, scalable, and privacy-focused.

Here is the link to the Front End Source Search Project Vanilla JS Frontend Source

Here is the Live link: Realtime Search Box

🛠 Built With

1- Ruby 3.2.2
2- Rails 7.0.7.2
3- PostgreSQL
4- Gitflow
5- Rubocop

Tech Stack

Client

• Helpjuice

Ruby

• Ruby

Rails

• Rails

Database

• PostgreSQL

Key Features

• [Set up the repository and tools]
• [Setup RAILS APP]
• [Created user and search models]
• [Created users and searches controllers]
• [Set routes]
• [Created API endpoint GET and POST]
• [Added API GET endpoint to show recent searches]
• [Added API GET endpoint to count searches]
• [Added API GET endpoint to show favorite word in searches]
• [Added API GET endpoint to show average of words per search]
• [Added Rspec test to models]
• [Implemented deployment in render]

(back to top)

🚀 Live Demo

Please, try my app:

Helpjuice Test Project: Realtime Search Box

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

Web Browser (Chrome recommended)
Code editor (VS recommended)
GitHub account

Setup

Clone this repository to your desired folder:

  cd my-folder
  git clone "https://github.com/JuanDBta/search-project-backend-rails.git"

Install

Go to your /search-project-backend-rails folder:

  cd search-project-backend-rails
  bundle install

Usage

1. Once the setup is complete, ensure you are still in the directory containing the Ultimate Booking bites file files.

2. To set up the database and seed initial data, run the following commands:

rails db:create
rails db:migrate

This will create the database and apply migrations.

If you want to populate the database you can run (this step is not required):

rails db:seed

  rails server

Run Tests

Go to your /search-project-backend-rails folder:

  cd search-project-backend-rails
  rspec

👥 Authors

👤 JUAN DAVID DIAZ

• GitHub: @JuanDBta
• Twitter: @simplebetsas
• LinkedIn: LinkedIn

(back to top)

🔭 Future Features

• [More analytics]

(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 give me a like, it doesn't cost you anything and it helps me a lot to keep working.

(back to top)

🙏 Acknowledgments

I would like to thank Mena and Emil from Helpjuice for this amazing opportunity!

(back to top)

❓ FAQ

• ["How can I see more projects associated with this author?"]

  • Check my @JuanDBta

• [How can I contact the author of this project?]

  • Check my LinkedIn profile or email me at simplebetsas@gmail.com

(back to top)

📝 License

This project is MIT licensed.

(back to top)