Self-hosted, federated location sharing app and server that prioritizes user privacy and security
end-to-end-encryption
location-sharing
privacy
self-hosted
federated
updated readme with up to date infos
+12
-16
+12
-16
README.md
+12
-16
README.md
···
2
2
3
3
PrivacyPin is (going to be) a secure self-hosted location sharing app designed to prioritize user privacy. It offers complete control over location sharing, allowing users to determine who can access their location and when. PrivacyPin is federated, so different servers can interoperate and users are not locked into a single provider. Additionally, it might provide real-time notifications when someone accesses their position (that will require self-hosted notifications, which I'm unsure how much of a pain that is).
4
4
5
-
6
5
> [!IMPORTANT]
7
6
> I’m in the process of rapidly iterating to establish a base on which testing can begin. The current tech stack is NOT the final one.
8
7
>
···
28
27
* Self-hostable backend server with basic API functionality.
29
28
* On/off control for location sharing.
30
29
* Simple UI for sharing location.
31
-
* Basic in-app location sharing.
30
+
* Basic user authentication system.
31
+
* Basic background location service for location sharing.
32
32
33
33
### **Phase 2 — Security & Usability Enhancements**
34
34
35
-
* Basic user authentication system.
36
-
* Basic background location service for location sharing
37
35
* Improved and polished UI/UX for the mobile app.
38
36
* Server-side data validation.
39
37
* More robust API design and error handling on the client.
···
68
66
### Setup
69
67
70
68
```bash
71
-
git clone https://github.com/azomDev/PrivacyPin.git
72
-
cd PrivacyPin
69
+
git clone https://tangled.org/azom.dev/PrivacyPin
70
+
cd app
73
71
bun i
72
+
cd ..
74
73
```
75
74
76
75
### Running the Environment
77
76
78
-
Open **3–4 terminals** and run the following in each:
77
+
Open **2 terminals** and run the following in each:
79
78
80
79
```bash
81
-
# Terminal 1
82
-
bun run vite
80
+
# Start the server
81
+
just server # "just s" also works
83
82
84
-
# Terminal 2
85
-
bun run app
86
-
87
-
# Terminal 3
88
-
bun run server
83
+
# Start the app
84
+
just app # "just a" also works
89
85
90
-
# (Optional) Terminal 4 — to run another app instance
91
-
bun run app
86
+
# (Optional) Run two apps instead of just one
87
+
just duo
92
88
```
93
89
94
90
## Contact