From b5aadc51f5aa29a916426449689392549789ad78 Mon Sep 17 00:00:00 2001 From: azomDev Date: Sun, 18 Jan 2026 15:21:43 -0500 Subject: [PATCH] updated readme with up to date infos --- README.md | 28 ++++++++++++---------------- 1 file changed, 12 insertions(+), 16 deletions(-) diff --git a/README.md b/README.md index f7f1e0b..d1c0ca7 100644 --- a/README.md +++ b/README.md @@ -2,7 +2,6 @@ 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). - > [!IMPORTANT] > 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. > @@ -28,12 +27,11 @@ PrivacyPin is still in early development, and the usage instructions will be pro * Self-hostable backend server with basic API functionality. * On/off control for location sharing. * Simple UI for sharing location. -* Basic in-app location sharing. +* Basic user authentication system. +* Basic background location service for location sharing. ### **Phase 2 — Security & Usability Enhancements** -* Basic user authentication system. -* Basic background location service for location sharing * Improved and polished UI/UX for the mobile app. * Server-side data validation. * More robust API design and error handling on the client. @@ -68,27 +66,25 @@ Make sure you have the following installed: ### Setup ```bash -git clone https://github.com/azomDev/PrivacyPin.git -cd PrivacyPin +git clone https://tangled.org/azom.dev/PrivacyPin +cd app bun i +cd .. ``` ### Running the Environment -Open **3–4 terminals** and run the following in each: +Open **2 terminals** and run the following in each: ```bash -# Terminal 1 -bun run vite - -# Terminal 2 -bun run app +# Start the server +just server # "just s" also works -# Terminal 3 -bun run server +# Start the app +just app # "just a" also works -# (Optional) Terminal 4 — to run another app instance -bun run app +# (Optional) Run two apps instead of just one +just duo ``` ## Contact -- 2.51.2