docs: updated readme.md

Signed-off-by: Varun Raj <varun@skcript.com>
This commit is contained in:
Varun Raj committed 2024-12-31 08:52:48 +05:30
1 parent c76ca0a842
commit e16c70818b
3 files changed
+28 -6

No files matched your search

+5 -1
View File
@@ -7,4 +7,8 @@ DB_PORT="" # Postgres Port number (Default: 5432)
DB_DATABASE_NAME="" # Name of the database
# Additional configuration
SECURE_COOKIE=false # Set to true to enable secure cookies
SECURE_COOKIE=false # Set to true to enable secure cookies
# Optional
GOOGLE_MAPS_API_KEY="" # Google Maps API Key for heatmap
GEMINI_API_KEY="" # Gemini API Key for parsing search query in "Find"
+20 -2
View File
@@ -39,6 +39,10 @@ Add the Immich API Key and immich url's to the env file (which you already have
IMMICH_API_KEY= # your_immich_api_key
IMMICH_URL = "http://local-ip-of-immich:port" # Your immich instace ip address and port
EXTERNAL_IMMICH_URL = "https://external-address" # External address of immich
# Optional
GOOGLE_MAPS_API_KEY= # Google Maps API Key
GEMINI_API_KEY= # Gemini API Key
```
Refer here for obtaining Immich API Key: https://immich.app/docs/features/command-line-interface#obtain-the-api-key
@@ -100,7 +104,7 @@ bun run dev
- [x] Dark Mode
- [x] Dockerize
- [ ] Authentication
- [x] Authentication
- [x] Push to github packages
## Tech Stack
@@ -110,6 +114,20 @@ bun run dev
- [Shadcn](https://shadcn.com/) for UI Components
- [Axios](https://axios-http.com/) for API calls
## External Services
These services are completely optional and you can use the tool without them. Just that they are used for some of the features. But we dont send any personal data to these services.
- [Google Maps](https://maps.google.com/) for heatmap
Google Maps Javascript API Key is used to render the maps layer for heatmap. When rendering the heatmap, we only send the location data to Google Maps and not any other data.
> Code where heatmap data is plotted: [src/pages/assets/geo-heatmap.tsx:32](./src/pages/assets/geo-heatmap.tsx#L32-L35)
- [Gemini](https://gemini.google.com/) for rewind video generation
Google Gemini 1.5 Flash model is used for parsing your search query in "Find" page. We do not send any personal data to Gemini, only data that is sent to Gemini is your search query and rest of the querying happes using [Immich's Smart Search API](https://immich.app/docs/api/search-smart)
> Code where Gemini is used: [src/helpers/gemini.helper.ts](./src/helpers/gemini.helper.ts)
## Contributing
Feel free to contribute to this project, I'm open to any suggestions and improvements. Please read the [CONTRIBUTING.md](./CONTRIBUTING.md) for more details.
Feel free to contribute to this project, I'm open to any suggestions and improvements. Please read the [CONTRIBUTING.md](./CONTRIBUTING.md) for more details.
+3 -3
View File
@@ -57,9 +57,9 @@ const responseSchema = {
export const parseFindQuery = async (query: string): Promise<FindQuery> => {
const prompt = `
Parse the following query and return the query and tags: ${query}
Additional Information For Parsing:
today's date is ${new Date().toISOString().split('T')[0]}
Parse the following query and return the query and tags: ${query}
Additional Information For Parsing:
today's date is ${new Date().toISOString().split('T')[0]}
`;
const { response } = await model.generateContent({