Helpjuice Test Project: Realtime Search Box
# Table of Contents
- [ About the Project](https://github.com/JuanDBta/search-project-backend-rails/blob/master/#about-project)
- [ Built With](https://github.com/JuanDBta/search-project-backend-rails/blob/master/#built-with)
- [Tech Stack](https://github.com/JuanDBta/search-project-backend-rails/blob/master/#tech-stack)
- [Key Features](https://github.com/JuanDBta/search-project-backend-rails/blob/master/#key-features)
- [ Getting Started](https://github.com/JuanDBta/search-project-backend-rails/blob/master/#getting-started)
- [Prerequisites](https://github.com/JuanDBta/search-project-backend-rails/blob/master/#prerequisites)
- [Setup](https://github.com/JuanDBta/search-project-backend-rails/blob/master/#setup)
- [Install](https://github.com/JuanDBta/search-project-backend-rails/blob/master/#install)
- [Usage](https://github.com/JuanDBta/search-project-backend-rails/blob/master/#usage)
- [ Authors](https://github.com/JuanDBta/search-project-backend-rails/blob/master/#authors)
- [ Future Features](https://github.com/JuanDBta/search-project-backend-rails/blob/master/#future-features)
- [ Contributing](https://github.com/JuanDBta/search-project-backend-rails/blob/master/#contributing)
- [ Show your support](https://github.com/JuanDBta/search-project-backend-rails/blob/master/#support)
- [ Acknowledgements](https://github.com/JuanDBta/search-project-backend-rails/blob/master/#acknowledgements)
- [ FAQ](https://github.com/JuanDBta/search-project-backend-rails/blob/master/#faq)
- [ License](https://github.com/JuanDBta/search-project-backend-rails/blob/master/#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 my [Search Project Vanilla JS Frontend App](https://github.com/JuanDBta/search-project-backend-rails/blob/master/https://github.com/JuanDBta/search-project-frontend-vanillajs)
## Built With
1- Ruby 3.2.2
2- Rails 7.0.7.2
3- PostgreSQL
4- Gitflow
5- Rubocop
### Tech Stack
Client
Ruby
Rails
Database
### Key Features
- **[Set up the repository and tools]**
- **[Setup RAILS APP]**
- **[Created API endpoint]**
(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:
```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
```
## Authors
**JUAN DAVID DIAZ**
- GitHub: [@JuanDBta](https://github.com/JuanDBta/search-project-backend-rails/blob/master/https://github.com/JuanDBta)
- Twitter: [@simplebetsas](https://github.com/JuanDBta/search-project-backend-rails/blob/master/https://twitter.com/simplebetsas)
- LinkedIn: [LinkedIn](https://github.com/JuanDBta/search-project-backend-rails/blob/master/https://linkedin.com/in/simplebet/)
(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](https://github.com/JuanDBta/search-project-backend-rails/blob/master/../../issues/).
(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](https://github.com/JuanDBta/search-project-backend-rails/blob/master/https://github.com/JuanDBta)
- **[How can I contact the author of this project?]**
- Check my [LinkedIn profile](https://github.com/JuanDBta/search-project-backend-rails/blob/master/https://linkedin.com/in/simplebet/) or email me at simplebetsas@gmail.com
(back to top)
## License
This project is [MIT](https://github.com/JuanDBta/search-project-backend-rails/blob/master/./LICENSE) licensed.
(back to top)