## Table of Contents
+
- [Environment Setup](environment.md)
- [Folder Structure](folder-structure.md)
- [Contribution Guide](contribution.md)
diff --git a/docs/docs/dev-guide/notes.md b/docs/docs/dev-guide/notes.md
index f2562902..a18027b3 100644
--- a/docs/docs/dev-guide/notes.md
+++ b/docs/docs/dev-guide/notes.md
@@ -1,4 +1,5 @@
# Developer Notes
+
- [x] ML models should be agnostic and configurable
- [x] Each action should be configurable from the environment config e.g. Face grouping, Place Identification, File Size Limits
- [x] API-first techniques and then build Web UI & Mobile Apps
@@ -12,30 +13,31 @@
- [x] Try to achieve best ratings incrementally as on: https://github.com/meichthys/foss_photo_libraries
## Features
-| Feature | Support |
-| - | - |
-| Demo | 🚧 |
-| Freeness | ✅ |
-| Automatic Mobile Upload | 🚧 |
-| Web App | 🚧 |
-| Android App | 🚧 |
-| iOS App | 🚧 |
-| Desktop App | 🚧 |
-| LivePhotos | ✅ |
-| Videos | ✅ |
-| Geolocation | ✅ |
-| Discovery | 🚧 |
-| Existing Folders | 🚧 |
-| Albums | ✅ |
-| Slideshow | 🚧 |
-| Timeline | 🚧 |
-| Sharing | ✅ |
-| Search | ✅ |
-| Duplicate Handling | ✅ |
-| User Defined Tags | 🚧 |
-| Docker Installation | ✅ |
-| Object/Face Recognition | ✅ |
-| Basic Editing | 🚧 |
-| EXIF Data | ✅ |
-| Multiple User Support | ✅ |
-| Authentication Providers | 🚧 |
+
+| Feature | Support |
+| ------------------------ | ------- |
+| Demo | 🚧 |
+| Freeness | ✅ |
+| Automatic Mobile Upload | 🚧 |
+| Web App | 🚧 |
+| Android App | 🚧 |
+| iOS App | 🚧 |
+| Desktop App | 🚧 |
+| LivePhotos | ✅ |
+| Videos | ✅ |
+| Geolocation | ✅ |
+| Discovery | 🚧 |
+| Existing Folders | 🚧 |
+| Albums | ✅ |
+| Slideshow | 🚧 |
+| Timeline | 🚧 |
+| Sharing | ✅ |
+| Search | ✅ |
+| Duplicate Handling | ✅ |
+| User Defined Tags | 🚧 |
+| Docker Installation | ✅ |
+| Object/Face Recognition | ✅ |
+| Basic Editing | 🚧 |
+| EXIF Data | ✅ |
+| Multiple User Support | ✅ |
+| Authentication Providers | 🚧 |
diff --git a/docs/docs/dev-guide/roadmap.md b/docs/docs/dev-guide/roadmap.md
index 5bcabba7..880bbf72 100644
--- a/docs/docs/dev-guide/roadmap.md
+++ b/docs/docs/dev-guide/roadmap.md
@@ -1,4 +1,5 @@
# Roadmap
+
- [x] Album Creation & Its CRUD (v2022.09.30)
- [x] Library APIs with Favourites, Hidden & Trash (v2022.09.30)
- [x] Get All Places from Photos & its Collection (v2022.10.31)
@@ -15,5 +16,8 @@
- [x] Open up for contributions to build Mobile & Web Application (v2023.08.31)
- [x] Enhance Image & Video Support (v2024.03.09)
- [x] Improvements to E2E Test Suite (v2024.03.09)
-- [ ] Sync content from Social Media Websites (v2024.07.31)
-- [ ] Generation of Memories (v2024.07.31)
+- [ ] Faster Worker using C++ (v2025.09.30)
+- [ ] Improved Video Support C++ (v2025.10.20)
+- [ ] UI Features except Home and Search (v2025.11.23)
+- [ ] Sync content from other providers: Apple iCloud, Google Photos (v2026.01.31)
+- [ ] Generation of Memories (v2025.03.31)
diff --git a/docs/docs/user-guide/deployment.md b/docs/docs/user-guide/deployment.md
index 0c8e08f8..f3286ae8 100644
--- a/docs/docs/user-guide/deployment.md
+++ b/docs/docs/user-guide/deployment.md
@@ -1,7 +1,9 @@
# Deployment
## Amazon Web Services (AWS)
+
Coming Soon!
## Oracle Cloud Infrastructure (OCI)
-Coming Soon!
\ No newline at end of file
+
+Coming Soon!
diff --git a/docs/docs/user-guide/features/albums.md b/docs/docs/user-guide/features/albums.md
index d4bb58c8..62f0fda9 100644
--- a/docs/docs/user-guide/features/albums.md
+++ b/docs/docs/user-guide/features/albums.md
@@ -1,5 +1,7 @@
# Albums
+
Enable this feature using API Configuration:
+
```bash
SMRITI_FEATURE_ALBUMS: true
```
@@ -7,16 +9,21 @@ SMRITI_FEATURE_ALBUMS: true
## Use Cases
### Create Album
+
TBD
### Update Album
+
TBD
### Get All Albums
+
TBD
### Get Album
+
TBD
### Delete Album
-TBD
\ No newline at end of file
+
+TBD
diff --git a/docs/docs/user-guide/features/explore.md b/docs/docs/user-guide/features/explore.md
index 3058f5b4..028e1fde 100644
--- a/docs/docs/user-guide/features/explore.md
+++ b/docs/docs/user-guide/features/explore.md
@@ -1,5 +1,7 @@
# Explore
+
Enable this feature using API Configuration:
+
```bash
SMRITI_FEATURE_EXPLORE: true
```
@@ -7,4 +9,5 @@ SMRITI_FEATURE_EXPLORE: true
## Use Cases
### Get Years Today
-TBD
\ No newline at end of file
+
+TBD
diff --git a/docs/docs/user-guide/features/library.md b/docs/docs/user-guide/features/library.md
index 7299dabe..060da6e3 100644
--- a/docs/docs/user-guide/features/library.md
+++ b/docs/docs/user-guide/features/library.md
@@ -1,19 +1,25 @@
# Library
## Favourites
+
Enable this feature using API Configuration:
+
```bash
SMRITI_FEATURE_FAVOURITES: true
```
## Hidden
+
Enable this feature using API Configuration:
+
```bash
SMRITI_FEATURE_HIDDEN: true
```
## Trash
+
Enable this feature using API Configuration:
+
```bash
SMRITI_FEATURE_TRASH: true
-```
\ No newline at end of file
+```
diff --git a/docs/docs/user-guide/features/metadata.md b/docs/docs/user-guide/features/metadata.md
index bf33ca07..54d0ccfb 100644
--- a/docs/docs/user-guide/features/metadata.md
+++ b/docs/docs/user-guide/features/metadata.md
@@ -1,5 +1,7 @@
# Metadata
+
This feature is enabled by default and can be configured like:
+
```bash
SMRITI_ML_METADATA_PARAMS: {"thumbnail_size":"512"}
```
diff --git a/docs/docs/user-guide/features/people.md b/docs/docs/user-guide/features/people.md
index 4c7e00b1..cfc93ec1 100644
--- a/docs/docs/user-guide/features/people.md
+++ b/docs/docs/user-guide/features/people.md
@@ -1,5 +1,7 @@
# People
+
Enable this feature using API Configuration:
+
```bash
SMRITI_FEATURE_PEOPLE: true
SMRITI_ML_FACES: true
@@ -10,10 +12,13 @@ SMRITI_ML_FACES_PARAMS: {"minutes":"1","face_threshold":"0.9","model":"vggface2"
## Use Cases
### Get All People
+
TBD
### Get Person
+
TBD
### Get Person MediaItems
-TBD
\ No newline at end of file
+
+TBD
diff --git a/docs/docs/user-guide/features/places.md b/docs/docs/user-guide/features/places.md
index 165def9f..434ff402 100644
--- a/docs/docs/user-guide/features/places.md
+++ b/docs/docs/user-guide/features/places.md
@@ -1,5 +1,7 @@
# Places
+
Enable this feature using API Configuration:
+
```bash
SMRITI_FEATURE_PLACES: true
SMRITI_ML_PLACES: true
@@ -9,10 +11,13 @@ SMRITI_ML_PLACES_PROVIDER: openstreetmap
## Use Cases
### Get All Places
+
TBD
### Get Place
+
TBD
### Get Place MediaItems
-TBD
\ No newline at end of file
+
+TBD
diff --git a/docs/docs/user-guide/features/search.md b/docs/docs/user-guide/features/search.md
index e01e9db2..7567391a 100644
--- a/docs/docs/user-guide/features/search.md
+++ b/docs/docs/user-guide/features/search.md
@@ -1,5 +1,7 @@
# Search
+
Enable this feature using API Configuration:
+
```bash
SMRITI_ML_SEARCH: true
SMRITI_ML_SEARCH_PROVIDER: pytorch
@@ -9,4 +11,5 @@ SMRITI_ML_SEARCH_PARAMS: {"tokenizer_dir":"search_tokenizer","processor_dir":"se
## Use Cases
### Search MediaItems
-TBD
\ No newline at end of file
+
+TBD
diff --git a/docs/docs/user-guide/features/things.md b/docs/docs/user-guide/features/things.md
deleted file mode 100644
index 5b9c6f81..00000000
--- a/docs/docs/user-guide/features/things.md
+++ /dev/null
@@ -1,19 +0,0 @@
-# Things
-Enable this feature using API Configuration:
-```bash
-SMRITI_FEATURE_THINGS: true
-SMRITI_ML_CLASSIFICATION: true
-SMRITI_ML_CLASSIFICATION_PROVIDER: pytorch
-SMRITI_ML_CLASSIFICATION_PARAMS: {"file":"classification_v240624.pt"}
-```
-
-## Use Cases
-
-### Get All Things
-TBD
-
-### Get Thing
-TBD
-
-### Get Thing MediaItems
-TBD
\ No newline at end of file
diff --git a/docs/docs/user-guide/features/users.md b/docs/docs/user-guide/features/users.md
index 5ebae7ea..eff5fb24 100644
--- a/docs/docs/user-guide/features/users.md
+++ b/docs/docs/user-guide/features/users.md
@@ -3,16 +3,21 @@
## Use Cases
### Create User
+
TBD
### Update User
+
TBD
### Get All Users
+
TBD
### Get User
+
TBD
### Delete User
-TBD
\ No newline at end of file
+
+TBD
diff --git a/docs/docs/user-guide/installation.md b/docs/docs/user-guide/installation.md
index 91f8656d..0f56d3be 100644
--- a/docs/docs/user-guide/installation.md
+++ b/docs/docs/user-guide/installation.md
@@ -1,17 +1,21 @@
# Installation
## Docker
-- Deploying with Docker is plain and simple.
-Refer to [docker-compose.yml](https://github.com/prabhuomkar/smriti/blob/master/docker-compose.yaml) for setting up services.
+
+- Deploying with Docker is plain and simple.
+ Refer to [docker-compose.yml](https://github.com/prabhuomkar/smriti/blob/master/docker-compose.yaml) for setting up services.
- Run all the services using:
+
```bah
docker-compose up -d
```
### Deploy using Docker Swarm
-- [Docker Swarm](https://docs.docker.com/engine/swarm/) is the preferred approach for now to deploy Smriti.
+
+- [Docker Swarm](https://docs.docker.com/engine/swarm/) is the preferred approach for now to deploy Smriti.
- Environment variables can be set in [infra/deployments/docker-swarm/docker-compose.yaml](https://github.com/prabhuomkar/smriti/blob/master/infra/deployments/docker-swarm/docker-compose.yaml).
- Run following command to start services:
+
```bash
docker swarm init
docker swarm join --token {message}
+{details}
+ {stack && ( +
+ {stack}
+
+ )}
+
+
+ );
+}
diff --git a/ui/app/pages/admin/jobs.jsx b/ui/app/pages/admin/jobs.jsx
new file mode 100644
index 00000000..b83593b1
--- /dev/null
+++ b/ui/app/pages/admin/jobs.jsx
@@ -0,0 +1,7 @@
+export function meta() {
+ return [{ title: "Admin Jobs - Smriti" }];
+}
+
+export default function Users() {
+ return
+ 
+
+
+
+
+
+ Admin Login
+
+
+ or{" "}
+
+ setup an admin
+
+
+
+ Admin Jobs
; +} diff --git a/ui/app/pages/admin/users.jsx b/ui/app/pages/admin/users.jsx new file mode 100644 index 00000000..c6fc7c61 --- /dev/null +++ b/ui/app/pages/admin/users.jsx @@ -0,0 +1,167 @@ +import { useEffect, useState } from "react"; +import { createUser, getUsers, updateUser } from "../../api/admin"; + +export function meta() { + return [{ title: "Admin Users - Smriti" }]; +} + +function CreateUser() { + const [name, setName] = useState(""); + const [username, setUsername] = useState(""); + const [password, setPassword] = useState(""); + const [loading, setLoading] = useState(false); + const [error, setError] = useState(""); + const [success, setSuccess] = useState(""); + + const handleCreateUser = async (e) => { + e.preventDefault(); + setLoading(true); + setError(""); + setSuccess(""); + + try { + let res = await createUser({ name, username, password }); + setSuccess(res); + } catch (err) { + setError(err); + } finally { + setLoading(false); + } + }; + + return ( + + ); +} + +function UpdateUser(user) { + const [id, _] = useState(user.id); + const [name, setName] = useState(user.name); + const [username, setUsername] = useState(user.username); + const [password, setPassword] = useState(user.password); + const [loading, setLoading] = useState(false); + const [error, setError] = useState(""); + const [success, setSuccess] = useState(""); + + const handleUpdateUser = async (e) => { + e.preventDefault(); + setLoading(true); + setError(""); + setSuccess(""); + + try { + let res = await updateUser(id, { name, username, password }); + setSuccess(res); + } catch (err) { + setError(err); + } finally { + setLoading(false); + } + }; + + return ( + + ); +} + +function ListUsers() { + const [users, setUsers] = useState([]); + const [loading, setLoading] = useState(false); + const [error, setError] = useState(""); + + useEffect(() => { + try { + setLoading(true); + let res = getUsers(); + res.then((data) => { + setUsers(data); + }); + } catch (err) { + setError(err); + } finally { + setLoading(false); + } + }, []); + + return ( +
+
+ );
+}
+
+export default function Users() {
+ return (
+ Users
+ {(!loading && + users && + users.length > 0 && + users.map((user) =>
+ {error &&
+ )}
+ {JSON.stringify(error)}
}
+
+
+ );
+}
diff --git a/ui/app/pages/albums/album.jsx b/ui/app/pages/albums/album.jsx
new file mode 100644
index 00000000..7b30b4cb
--- /dev/null
+++ b/ui/app/pages/albums/album.jsx
@@ -0,0 +1,11 @@
+import { useParams } from "react-router";
+
+export function meta() {
+ return [{ title: "(TODO) Album Name - Smriti" }];
+}
+
+export default function Album() {
+ const { id } = useParams();
+
+ return Admin Users
+Album: {id}
; +} diff --git a/ui/app/pages/albums/index.jsx b/ui/app/pages/albums/index.jsx new file mode 100644 index 00000000..ce0e0335 --- /dev/null +++ b/ui/app/pages/albums/index.jsx @@ -0,0 +1,7 @@ +export function meta() { + return [{ title: "Albums - Smriti" }]; +} + +export default function Albums() { + returnAlbums
; +} diff --git a/ui/app/pages/auth/login.jsx b/ui/app/pages/auth/login.jsx new file mode 100644 index 00000000..d359a7f4 --- /dev/null +++ b/ui/app/pages/auth/login.jsx @@ -0,0 +1,7 @@ +export function meta() { + return [{ title: "Login - Smriti" }]; +} + +export default function Login() { + returnUsers Login
; +} diff --git a/ui/app/pages/explore/people.jsx b/ui/app/pages/explore/people.jsx new file mode 100644 index 00000000..d8a9c133 --- /dev/null +++ b/ui/app/pages/explore/people.jsx @@ -0,0 +1,7 @@ +export function meta() { + return [{ title: "People - Smriti" }]; +} + +export default function People() { + returnPeople
; +} diff --git a/ui/app/pages/explore/person.jsx b/ui/app/pages/explore/person.jsx new file mode 100644 index 00000000..757f8818 --- /dev/null +++ b/ui/app/pages/explore/person.jsx @@ -0,0 +1,11 @@ +import { useParams } from "react-router"; + +export function meta() { + return [{ title: "(TODO) Person Name - Smriti" }]; +} + +export default function Person() { + const { id } = useParams(); + + returnPerson: {id}
; +} diff --git a/ui/app/pages/explore/place.jsx b/ui/app/pages/explore/place.jsx new file mode 100644 index 00000000..f9b4473f --- /dev/null +++ b/ui/app/pages/explore/place.jsx @@ -0,0 +1,11 @@ +import { useParams } from "react-router"; + +export function meta() { + return [{ title: "(TODO) Place Name - Smriti" }]; +} + +export default function Place() { + const { id } = useParams(); + + returnPlace: {id}
; +} diff --git a/ui/app/pages/explore/places.jsx b/ui/app/pages/explore/places.jsx new file mode 100644 index 00000000..c0afb097 --- /dev/null +++ b/ui/app/pages/explore/places.jsx @@ -0,0 +1,7 @@ +export function meta() { + return [{ title: "Places - Smriti" }]; +} + +export default function Places() { + returnPlaces
; +} diff --git a/ui/app/pages/explore/thing.jsx b/ui/app/pages/explore/thing.jsx new file mode 100644 index 00000000..6ca4e504 --- /dev/null +++ b/ui/app/pages/explore/thing.jsx @@ -0,0 +1,11 @@ +import { useParams } from "react-router"; + +export function meta() { + return [{ title: "(TODO) Thing Name - Smriti" }]; +} + +export default function Thing() { + const { id } = useParams(); + + returnThing: {id}
; +} diff --git a/ui/app/pages/explore/things.jsx b/ui/app/pages/explore/things.jsx new file mode 100644 index 00000000..c84fe2c5 --- /dev/null +++ b/ui/app/pages/explore/things.jsx @@ -0,0 +1,7 @@ +export function meta() { + return [{ title: "Things - Smriti" }]; +} + +export default function Things() { + returnThings
; +} diff --git a/ui/app/pages/home/index.jsx b/ui/app/pages/home/index.jsx new file mode 100644 index 00000000..2e28aa9c --- /dev/null +++ b/ui/app/pages/home/index.jsx @@ -0,0 +1,7 @@ +export function meta() { + return [{ title: "Home - Smriti" }]; +} + +export default function Home() { + returnHome
; +} diff --git a/ui/app/pages/library/favourites.jsx b/ui/app/pages/library/favourites.jsx new file mode 100644 index 00000000..2f0e800f --- /dev/null +++ b/ui/app/pages/library/favourites.jsx @@ -0,0 +1,7 @@ +export function meta() { + return [{ title: "Favourites - Smriti" }]; +} + +export default function Favourites() { + returnFavourites
; +} diff --git a/ui/app/pages/library/hidden.jsx b/ui/app/pages/library/hidden.jsx new file mode 100644 index 00000000..1c6768a1 --- /dev/null +++ b/ui/app/pages/library/hidden.jsx @@ -0,0 +1,7 @@ +export function meta() { + return [{ title: "Hidden - Smriti" }]; +} + +export default function Hidden() { + returnHidden
; +} diff --git a/ui/app/pages/library/trash.jsx b/ui/app/pages/library/trash.jsx new file mode 100644 index 00000000..a9180848 --- /dev/null +++ b/ui/app/pages/library/trash.jsx @@ -0,0 +1,7 @@ +export function meta() { + return [{ title: "Trash - Smriti" }]; +} + +export default function Trash() { + returnTrash
; +} diff --git a/ui/app/pages/sharing/index.jsx b/ui/app/pages/sharing/index.jsx new file mode 100644 index 00000000..86733668 --- /dev/null +++ b/ui/app/pages/sharing/index.jsx @@ -0,0 +1,7 @@ +export function meta() { + return [{ title: "Sharing - Smriti" }]; +} + +export default function Sharing() { + returnSharing
; +} diff --git a/ui/app/pages/sharing/sharedalbum.jsx b/ui/app/pages/sharing/sharedalbum.jsx new file mode 100644 index 00000000..b95094c1 --- /dev/null +++ b/ui/app/pages/sharing/sharedalbum.jsx @@ -0,0 +1,11 @@ +import { useParams } from "react-router"; + +export function meta() { + return [{ title: "(TODO) Shared Album Name - Smriti" }]; +} + +export default function SharedAlbum() { + const { id } = useParams(); + + returnShared Album: {id}
; +} diff --git a/ui/app/root.jsx b/ui/app/root.jsx new file mode 100644 index 00000000..9ec8f7a2 --- /dev/null +++ b/ui/app/root.jsx @@ -0,0 +1,77 @@ +import { + isRouteErrorResponse, + Links, + Meta, + Outlet, + Scripts, + ScrollRestoration, +} from "react-router"; + +import "./app.css"; + +export const links = () => [ + { rel: "preconnect", href: "https://fonts.googleapis.com" }, + { + rel: "preconnect", + href: "https://fonts.gstatic.com", + crossOrigin: "anonymous", + }, + { + rel: "stylesheet", + href: "https://fonts.googleapis.com/css2?family=DM+Sans:wght@400;500;700&display=swap", + }, +]; + +export function Layout({ children }) { + return ( + + + + + +