{"id":23461001,"url":"https://github.com/nikhilsindhu/restro-finder","last_synced_at":"2025-04-12T04:19:44.630Z","repository":{"id":257988104,"uuid":"864546910","full_name":"nikhilsindhu/restro-finder","owner":"nikhilsindhu","description":"Restro Finder is an application that helps users discover the best restaurants and cuisines around them","archived":false,"fork":false,"pushed_at":"2024-09-28T18:03:46.000Z","size":13348,"stargazers_count":1,"open_issues_count":0,"forks_count":0,"subscribers_count":1,"default_branch":"master","last_synced_at":"2025-04-12T04:19:36.196Z","etag":null,"topics":["faker-js","places-api","restaurant-reviews"],"latest_commit_sha":null,"homepage":"https://nikhilsindhu.github.io/restro-finder/","language":"JavaScript","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":null,"status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/nikhilsindhu.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":null,"code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null}},"created_at":"2024-09-28T14:07:34.000Z","updated_at":"2024-09-28T18:14:01.000Z","dependencies_parsed_at":null,"dependency_job_id":"e82a05cb-70d5-48e1-a6c1-9c9cfa89c20b","html_url":"https://github.com/nikhilsindhu/restro-finder","commit_stats":null,"previous_names":["nikhilsindhu/restro-finder"],"tags_count":0,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/nikhilsindhu%2Frestro-finder","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/nikhilsindhu%2Frestro-finder/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/nikhilsindhu%2Frestro-finder/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/nikhilsindhu%2Frestro-finder/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/nikhilsindhu","download_url":"https://codeload.github.com/nikhilsindhu/restro-finder/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":248514190,"owners_count":21116907,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["faker-js","places-api","restaurant-reviews"],"created_at":"2024-12-24T07:26:47.872Z","updated_at":"2025-04-12T04:19:44.605Z","avatar_url":"https://github.com/nikhilsindhu.png","language":"JavaScript","funding_links":[],"categories":[],"sub_categories":[],"readme":"# Restaurant Finder 🍽️\n\nRestaurant Finder is a React application that helps users discover the best restaurants and cuisines around them. It allows users to search based on either geographic coordinates or specific locations, leveraging the power of the Google Places API. If a Google Places API Key is not provided, the app uses **Faker.js** to generate random restaurant data for testing and demo purposes.\n\n## Features ✨\n\n- **Location-based Search**: Enter coordinates or search by a location name (e.g., HSR Layout) to find nearby restaurants.\n- **Google Places API Integration**: Get real-time data on restaurants, their ratings, and other key details.\n- **Faker.js for Mock Data**: Don't have an API key? No problem! The app generates realistic restaurant data using Faker.js.\n- **Custom Sorting**: View restaurants sorted by ratings, proximity, and more.\n- **Responsive Design**: The app works seamlessly across devices with a clean and user-friendly interface.\n\n## Screenshots 📸\n\n### Home Search\n\n![Restaurant Finder Home](./src/assets/images/home_search.png)\n\n### Search Results\n\n![Restaurant Finder Results](./src/assets/images/search_results.png)\n\n## Installation ⚙️\n\n1. Clone the repository:\n\n   ```bash\n   git clone https://github.com/nikhilsindhu/restro-finder.git\n   cd restro-finder\n   ```\n\n2. Install dependencies:\n\n   ```bash\n   npm install\n   ```\n\n3. Add your Google Places API Key:\n\n   - Create a `.env` file at the root of your project.\n   - Add the following line to the `.env` file:\n     ```bash\n     REACT_APP_GOOGLE_API_KEY=your_api_key_here\n     ```\n\n4. Run the app:\n\n   ```bash\n   npm start\n   ```\n\n5. Open [http://localhost:3000](http://localhost:3000) to view the app in your browser.\n\n## Usage 🛠️\n\n1. Enter your current location using either:\n   - Geo coordinates (latitude, longitude), or\n   - A specific location (e.g., 2nd Cross Road, HSR Layout)\n2. Click the search button.\n3. View restaurants around you, sorted by reviews.\n\n## Technology Stack 🧑‍💻\n\n- **Frontend**: React, JavaScript\n- **API**: Google Places API, Faker.js (for mock data)\n- **Styling**: SCSS\n\n## Contributing 🤝\n\nContributions, issues, and feature requests are welcome! Feel free to check out the [issues page](https://github.com/yourusername/restaurant-finder/issues).\n\n## License 📜\n\nThis project is licensed under the MIT License - see the [LICENSE](LICENSE) file for details.\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fnikhilsindhu%2Frestro-finder","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fnikhilsindhu%2Frestro-finder","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fnikhilsindhu%2Frestro-finder/lists"}