https://github.com/cancelei/search_engine
SearchEngine made with Ruby on Rails 7.1. Works for Google, Bing or Brave API.
https://github.com/cancelei/search_engine
bingsearchapi bravesearchapi googlesearchapi ruby rubyonrails
Last synced: 4 months ago
JSON representation
SearchEngine made with Ruby on Rails 7.1. Works for Google, Bing or Brave API.
- Host: GitHub
- URL: https://github.com/cancelei/search_engine
- Owner: cancelei
- License: mit
- Created: 2024-06-19T21:16:42.000Z (11 months ago)
- Default Branch: dev
- Last Pushed: 2024-07-03T15:12:52.000Z (11 months ago)
- Last Synced: 2025-01-14T11:47:24.285Z (4 months ago)
- Topics: bingsearchapi, bravesearchapi, googlesearchapi, ruby, rubyonrails
- Language: HTML
- Homepage: https://ecosearch-test.oasisofchange.org/
- Size: 188 KB
- Stars: 5
- Watchers: 1
- Forks: 2
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# 🚀 Rails SearchEngine
Welcome to ** Rails SearchEngine**, the coolest search engine on the block, built with Ruby on Rails and powered by the Bing, Google and Brave Search APIs! We want to plant trees with our ads revenue.🌳
## Prerequisites
Before you begin, make sure you have the following installed:
- Ruby (3.2.4)
- Rails (7.1.3.4)
- PostgreSQL
- Redis (For Background Jobs)
In the future also:
- Node.js
- Yarn
## Getting Started
1. **Clone the repository**
```sh
git clone https://github.com/yourusername/search_engine.git
cd search_engine
```
2. **Install dependencies**
```sh
bundle install
```
3. **Set up the database**
```sh
rails db:create
rails db:migrate
```
4. **Configure your environment variables**
Rename `.env.erb` to `.env` and fill in the necessary details:
```env
BING_API_KEY=your_bing_api_key_here
GOOGLE_API_KEY=your_google_api_key_here
GOOGLE_CX_KEY=your_google_search_engine_id_here
BRAVE_API_KEY=your_brave_api_key_here
```
5. **Run the app**
```sh
bin/dev
```
This command will spin up your Rails server and the frontend environment. Open your browser and navigate to `http://localhost:3000` to see the magic happen!
## Features
- **Search Functionality**: Harness the power of Bing, Google and Brave Search API to fetch the search results.
- **User Authentication**: Sign up, sign in, and edit your profile.
- **Search History**: Registered users can view their search history.
- **Tailwind CSS Styling**: Beautifully styled with Tailwind CSS.
## Project Structure
- **Controllers**: `app/controllers`
- **Models**: `app/models`
- **Views**: `app/views`
- **Styles**: `app/assets/stylesheets`
- **JavaScript**: `app/javascript`
## Contributing
Feel free to fork this repository and send a pull request with your changes. We welcome all contributions!
## License
This project is licensed under the MIT License. See the [LICENSE](LICENSE) file for more details.
Happy coding! ✨
