yodit93/Helpjuice-search-back-end

Table of Contents

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

📖 Holpjuice search

The Helpjuice Search Backend is a RESTful API built using Ruby on Rails. It provides endpoints to handle search queries, save search history, and generate analytics on user search behavior. The project focuses on capturing search queries made by users and analyzing the most frequently searched terms. It is part of the Helpjuice full stack project.

Built With

Tech Stack

Backend

• Ruby on Rails

Database

• Postgresql

Key Features

Api end points for:

• posting a user search query
• getting a users search analytics

(back to top)

🚀 Live Demo

Link to deployed project.

• Live Demo Link

(back to top)

• Helpjuice-search-frontend Helpjuice-search-frontend

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

• Any web-browser.
• Latest version of Ruby on Rails

Setup

Clone this repo to your desired folder.

    git clone https://github.com/yodit93/Helpjuice-search-back-end.git

Install

Run from a terminal

    cd Helpjuice-search-back-end
    bundle install

Database

To connect the project to the database:-

    rails db:create
    rails db:migrate

Usage

To run the project follow the following instruction:-

    rails s -p 3001

Run tests (using rspec)

To run the models test

  rspec ./spec/models

Deployment

You can deploy this project using: render.

(back to top)

## Authors <a name="authors"></a>

👤 **Yodit Abebe**

- GitHub: [yodit93](https://github.com/yodit93)
- Twitter: [@yodtwit](https://twitter.com/yodtwit)
- LinkedIn: [Yodit Abebe](https://www.linkedin.com/in/yodit-abebe-ayalew/)



## Future Features <a name="future-features"></a>

- **Add authentication and authorization**
- **Add additional functionalities**

<p align="right">(<a href="#table-of-contents">back to top</a>)</p>


## Contributing <a name="contributing"></a>

Contributions, issues, and feature requests are welcome!

Feel free to check the [issues page](../../issues).

<p align="right">(<a href="#table-of-contents">back to top</a>)</p>


## Support <a name="support"></a>

If you like this project give us a ⭐️.

<p align="right">(<a href="#table-of-contents">back to top</a>)</p>


## Acknowledgments <a name="acknowledgements"></a>

I would like to thank Hotjuice team for giving me this chance.

<p align="right">(<a href="#table-of-contents">back to top</a>)</p>


## License <a name="license"></a>

This project is [MIT](./LICENSE) licensed.

<p align="right">(<a href="#table-of-contents">back to top</a>)</p>