Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/juandbta/search-project-backend-rails
Realtime Search Box Analytics: Instantly track user searches via IP for personalized insights. Focus on analytics, uncovering trending topics per user. Revolutionize search with privacy-centric data analysis.
https://github.com/juandbta/search-project-backend-rails
api backend database endpoint json posgresql rspec rubocop ruby-on-rails
Last synced: about 2 months ago
JSON representation
Realtime Search Box Analytics: Instantly track user searches via IP for personalized insights. Focus on analytics, uncovering trending topics per user. Revolutionize search with privacy-centric data analysis.
- Host: GitHub
- URL: https://github.com/juandbta/search-project-backend-rails
- Owner: JuanDBta
- License: mit
- Created: 2024-01-05T21:35:48.000Z (about 1 year ago)
- Default Branch: dev
- Last Pushed: 2024-01-08T01:32:08.000Z (about 1 year ago)
- Last Synced: 2024-12-18T17:13:09.293Z (about 2 months ago)
- Topics: api, backend, database, endpoint, json, posgresql, rspec, rubocop, ruby-on-rails
- Language: Ruby
- Homepage: https://search-project.onrender.com/
- Size: 83 KB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
Helpjuice Test Project: Realtime Search Box
# 📗 Table of Contents
- [📖 About the Project](#about-project)
- [🛠 Built With](#built-with)
- [Tech Stack](#tech-stack)
- [Key Features](#key-features)
- [🚀 Live Demo](#live-demo)
- [💻 Getting Started](#getting-started)
- [Prerequisites](#prerequisites)
- [Setup](#setup)
- [Install](#install)
- [Usage](#usage)
- [Run Tests](#tests)
- [👥 Authors](#authors)
- [🔭 Future Features](#future-features)
- [🤝 Contributing](#contributing)
- [⭐️ Show your support](#support)
- [🙏 Acknowledgements](#acknowledgements)
- [❓ FAQ](#faq)
- [📝 License](#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](https://github.com/JuanDBta/search-project-frontend-vanillajs)
Here is the Live link:
[Realtime Search Box](https://search-project.onrender.com/)
1- Ruby 3.2.2
2- Rails 7.0.7.2
3- PostgreSQL
4- Gitflow
5- Rubocop
Client
Ruby
Rails
Database
- **[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]**
Please, try my app:
Helpjuice Test Project: Realtime Search Box
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:
```sh
cd my-folder
git clone "https://github.com/JuanDBta/search-project-backend-rails.git"
```
### Install
Go to your /search-project-backend-rails folder:
```sh
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
```
```sh
rails server
```
### Run Tests
Go to your /search-project-backend-rails folder:
```sh
cd search-project-backend-rails
rspec
```
👤 **JUAN DAVID DIAZ**
- GitHub: [@JuanDBta](https://github.com/JuanDBta)
- Twitter: [@simplebetsas](https://twitter.com/simplebetsas)
- LinkedIn: [LinkedIn](https://linkedin.com/in/simplebet/)
- [ ] **[More analytics]**
Contributions, issues, and feature requests are welcome!
Feel free to check the [issues page](../../issues/).
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.
I would like to thank Mena and Emil from Helpjuice for this amazing opportunity!
- **["How can I see more projects associated with this author?"]**
- Check my [@JuanDBta](https://github.com/JuanDBta)
- **[How can I contact the author of this project?]**
- Check my [LinkedIn profile](https://linkedin.com/in/simplebet/) or email me at [email protected]
This project is [MIT](./LICENSE) licensed.