Release v0.1.0

Author: bhatushar

.env.example

@@ -0,0 +1,12 @@
+# Database credentials
+DATABASE_URL=postgresql://root:mysecretpassword@localhost:5432/snapsort
+POSTGRES_USER=root
+POSTGRES_PASSWORD=mysecretpassword
+
+# Path to external binaries
+EXIFTOOL_PATH="/snap-sort/data/exiftool/exiftool.exe"
+FFMPEG_PATH="/snap-sort/data/ffmpeg/bin/ffmpeg.exe"
+
+# Path to data storage
+FILE_UPLOAD_DIR="/snap-sort/data/uploaded-files"
+LIBRARY_ROOT_DIR="/snap-sort/data/library"

.gitignore

@@ -7,6 +7,7 @@ node_modules
 .wrangler
 /.svelte-kit
 /build
+/data
 
 # OS
 .DS_Store

.idea/dataSources.xml

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2025 Tushar Bhatt
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

.idea/dictionaries/project.xml

@@ -1,38 +1,180 @@
-# sv
+# SnapSort
 
-Everything you need to build a Svelte project, powered by [`sv`](https://github.com/sveltejs/cli).
+A very opinionated solution for a personal problem of organizing a photos/videos library. SnapSort helps you organize
+media files (images/videos) and edit metadata.
 
-## Creating a project
+## Features
 
-If you're seeing this, you've probably already done this step. Congrats!
+### Metadata Management
 
-```bash
-# create a new project in the current directory
-npx sv create
+- **Create Keywords**: Create different types of keywords (Album, Location, Person, Animal, Group, or Other) which can
+  be used to tag files.
+- **Edit Metadata**: Modify capture date and time, title/descriptions, GPS data, and keywords for your media files.
+- **Batch Editing**: Apply metadata changes to multiple files at once, saving time and ensuring consistency.
+- **View Metadata**: View all metadata associated with your library files.
+- **EXIF Data Export**: Export metadata from your library files for backup or analysis.
+
+### Library Organization
+
+Media library is organized in a "Year / Month / Day" hierarchy. The Day folder may have a `- Keyword` suffix
+depending on whether any of the files within that folder contains a keyword which can be used as a folder label.
+
+The files follow the following naming convention: `TYPE-YYYYMMDD-INDEX`
 
-# create a new project in my-app
-npx sv create my-app
 ```
+library/
+    |- 2025/
+        |- 01 - January/
+            |- 01/
+                |- IMG-20250101-000.jpg
+                |- VID-20250101-000.mp4
+            |- 02 - Birthday/
+                |- IMG-20250102-000.jpg
+                |- IMG-20250102-001.jpg
+```
+
+## Prerequisites
+
+- [Node.js](https://nodejs.org/) (v18 or later)
+- [PNPM](https://pnpm.io/) package manager
+- [Docker](https://www.docker.com/) and [Docker Compose](https://docs.docker.com/compose/) (for PostgreSQL database)
+- [ExifTool](https://exiftool.org/) (for metadata manipulation)
+- [FFmpeg](https://ffmpeg.org/) (for video processing)
+
+## Installation
+
+1. Clone the repository:
+
+   ```bash
+   git clone https://github.com/bhatushar/snap-sort.git
+   cd snap-sort
+   ```
+
+2. Install dependencies:
+
+   ```bash
+   pnpm install
+   ```
+
+3. Create a `.env` file based on the provided `.env.example`:
+
+   ```bash
+   cp .env.example .env
+   ```
 
-## Developing
+4. Edit the `.env` file to configure your environment:
 
-Once you've created a project and installed dependencies with `npm install` (or `pnpm install` or `yarn`), start a development server:
+   - Set database credentials
+   - Configure paths to ExifTool and FFmpeg
+   - Set file storage directories
+
+5. Start the PostgreSQL database using Docker:
+
+   ```bash
+   pnpm db:start
+   ```
+
+6. Initialize the database:
+   ```bash
+   pnpm db:push
+   ```
+
+## Running the Application
+
+### Development Mode
+
+Run the application in development mode:
 
 ```bash
-npm run dev
+pnpm dev
+```
 
-# or start the server and open the app in a new browser tab
-npm run dev -- --open
+To make the development server accessible on your local network:
+
+```bash
+pnpm dev-network
 ```
 
-## Building
+### Production Mode
+
+Build the application for production:
+
+```bash
+pnpm build
+```
 
-To create a production version of your app:
+Preview the production build:
 
 ```bash
-npm run build
+pnpm preview
+```
+
+Run the production server:
+
+```bash
+node build
+```
+
+## Database Management
+
+- Push schema changes to the database:
+
+  ```bash
+  pnpm db:push
+  ```
+
+- Create migrations:
+
+  ```bash
+  pnpm db:migrate
+  ```
+
+- Open Drizzle Studio to manage database:
+  ```bash
+  pnpm db:studio
+  ```
+
+## Project Structure
+
+- `/src`: Source code
+  - `/lib`: Library code
+    - `/server`: Server-side code
+      - `/db`: Database models and operations
+  - `/routes`: SvelteKit routes
+- `/static`: Static assets
+
+## Configuration
+
+The application requires several environment variables to be set in the `.env` file:
+
+### Database Configuration
+
+```
+DATABASE_URL=postgresql://root:mysecretpassword@localhost:5432/snapsort
+POSTGRES_USER=root
+POSTGRES_PASSWORD=mysecretpassword
+```
+
+### External Tools
+
+```
+EXIFTOOL_PATH="/path/to/exiftool"
+FFMPEG_PATH="/path/to/ffmpeg"
+```
+
+### File Storage
+
+```
+FILE_UPLOAD_DIR="/path/to/uploaded-files"
+LIBRARY_ROOT_DIR="/path/to/library"
 ```
 
-You can preview the production build with `npm run preview`.
+## Usage
 
-> To deploy your app, you may need to install an [adapter](https://svelte.dev/docs/kit/adapters) for your target environment.
+1. Start the application and navigate to the web interface
+2. Create new keywords
+3. Upload your media files
+4. Edit metadata as needed (date/time, description, GPS data, keywords)
+5. Apply the changes to temporarily modify the queued files
+6. Move files to the library to permanently save files
+7. Export metadata when needed for backup

.idea/prettier.xml

@@ -0,0 +1,14 @@
+services:
+  snapsort-db:
+    image: postgres
+    restart: always
+    ports:
+      - '5432:5432'
+    environment:
+      POSTGRES_DB: snapsort
+      POSTGRES_USER: ${POSTGRES_USER}
+      POSTGRES_PASSWORD: ${POSTGRES_PASSWORD}
+    volumes:
+      - pgdata:/var/lib/postgresql/data
+volumes:
+  pgdata:

.idea/snap-sort.iml

@@ -0,0 +1,11 @@
+import { defineConfig } from 'drizzle-kit';
+
+if (!process.env.DATABASE_URL) throw new Error('DATABASE_URL is not set');
+
+export default defineConfig({
+	schema: './src/lib/server/db/schema.ts',
+	dbCredentials: { url: process.env.DATABASE_URL },
+	verbose: true,
+	strict: true,
+	dialect: 'postgresql'
+});