Search-App-API

📗 Table of Contents

• 📖 About the Project
  • 🛠 Built With
    • Tech Stack
    • Key Features
  • 🚀 Live Demo
• 💻 Getting Started
  • Setup
  • Prerequisites
  • Install
  • Usage
• 👥 Authors
• 🔭 Future Features
• 🙏 Acknowledgements
• 📝 License

📖 What is Search App API?

Search App API is the backend of a full-stack solution that enables users to search any Torre profile by name, favorite profiles, and save their most recent searches.

🛠 Built With

Tech Stack

Client

• React to create the UI.
• Redux Toolkit to manage state.
• Tailwindcss to apply awesome styles.

Server

• Torre API
• Ruby on Rails

Database

• PostgreSQL

Key Features

• Data Model

(back to top)

🚀 Live Demo

• Live Demo

(back to top)

💻 Getting Started

To get a local copy up and running follow these simple example steps.

Prerequisites

You need the following tools be installed in your computer:

• Rails
• Git
• Ruby

Setup

Clone this repository to your desired folder:

cd my-prefered-folder
  
git clone https://github.com/jmonto55/search-app-api.git

Install

Install this project with:

cd search-app-api
  
bundle

💾 Database

Create the databases,run migrations, and populate it with seed data:

rails db:create
rails db:migrate

Usage

To run the project run the following commands:

rails tailwindcss:build
rails s

(back to top)

👥 Authors

👤 Jose Montoya

• GitHub: @jmonto55
• LinkedIn: jmontodev

(back to top)

🔭 Future Features

• Add options to eliminate recent searches and favorite profiles
• Fine tune queries with the bullet gem to make them as efficient as possible
• Document the API created using Swagger gem

(back to top)

🙏 Acknowledgments

I would like to thank Torre for their awesome API and test.

(back to top)

📝 License

This project is MIT licensed.

(back to top)