|
1 |
| -# Gemini Recommended Search |
| 1 | + |
| 2 | + |
| 3 | +# Summary |
2 | 4 | A Google AI hackathon project by Michael Gathara and Jayden Pyles. Built on top of the [Chrome Extension Typescript Starter](https://github.com/chibat/chrome-extension-typescript-starter)
|
3 | 5 |
|
4 |
| -## Prerequisites |
| 6 | +As you browse the web, Gemini Recommended Search scans your content and leverages Gemini's advanced capabilities to generate precise Google search queries. Instantly, you're presented with additional webpages tailored to you—allowing you to find content across the web that helps you. |
| 7 | + |
| 8 | +## Features |
| 9 | + |
| 10 | +### Smart Content Discovery and Content Summary |
| 11 | +- Seamlessly discover relevant content as you browse |
| 12 | +- Get intelligent recommendations based on your current page context |
| 13 | +- Save time finding related resources across the web |
| 14 | +- Get content summaries to enhance understanding |
5 | 15 |
|
6 |
| -* [node + npm](https://nodejs.org/) (Current Version) |
| 16 | + |
7 | 17 |
|
8 |
| -## Includes the following |
| 18 | +### Powered by Gemini AI |
| 19 | +- Advanced content analysis for precise recommendations |
| 20 | +- Real-time query generation tailored to your interests |
| 21 | +- High-quality results powered by Google's latest AI technology |
9 | 22 |
|
10 |
| -* TypeScript |
11 |
| -* Webpack |
12 |
| -* React |
13 |
| -* Jest |
14 |
| -* Example Code |
15 |
| - * Chrome Storage |
16 |
| - * Options Version 2 |
17 |
| - * content script |
18 |
| - * count up badge number |
19 |
| - * background |
| 23 | +### Simple & Privacy-Focused |
| 24 | +- Works automatically in the background while you browse |
| 25 | +- Your browsing data stays local to your device |
20 | 26 |
|
21 |
| -## Project Structure |
| 27 | +## How to run |
| 28 | +### Prerequisites |
22 | 29 |
|
23 |
| -* src/typescript: TypeScript source files |
24 |
| -* src/assets: static files |
25 |
| -* dist: Chrome Extension directory |
26 |
| -* dist/js: Generated JavaScript files |
| 30 | +* [node + npm](https://nodejs.org/) |
| 31 | +* [Docker](https://www.docker.com/) |
| 32 | +* [Python](https://python.org/) |
| 33 | +* [Make](https://www.gnu.org/software/make/) |
27 | 34 |
|
28 |
| -## Setup |
29 | 35 |
|
| 36 | +### Setup |
| 37 | + |
| 38 | +- Frontend |
30 | 39 | ```
|
31 | 40 | npm install
|
32 | 41 | ```
|
33 | 42 |
|
34 |
| -## Build |
| 43 | +- Backend |
| 44 | +``` |
| 45 | +make build up |
| 46 | +``` |
| 47 | + |
| 48 | +### Build frontend assets |
35 | 49 |
|
36 | 50 | ```
|
37 | 51 | npm run build
|
38 | 52 | ```
|
39 | 53 |
|
40 |
| -## Build in watch mode |
41 |
| - |
42 |
| -### terminal |
| 54 | +or |
43 | 55 |
|
44 | 56 | ```
|
45 |
| -npm run watch |
| 57 | +make build-ext |
46 | 58 | ```
|
47 | 59 |
|
48 |
| -## Load extension to chrome |
| 60 | +### Load extension to chrome |
49 | 61 |
|
50 | 62 | Load `dist` directory
|
51 |
| - |
52 |
| -## Test |
53 |
| -`npx jest` or `npm run test` |
|
0 commit comments