From 62a0d9666149a92c1abbb65dc6dc659d44f82317 Mon Sep 17 00:00:00 2001 From: Trent Larson Date: Tue, 20 May 2025 20:14:36 -0600 Subject: [PATCH] tweak purpose, add 'repos' link --- .cursor/rules/README.mdc | 22 +++++++++++++--------- README.md | 6 ++++-- repos | 1 + 3 files changed, 18 insertions(+), 11 deletions(-) create mode 120000 repos diff --git a/.cursor/rules/README.mdc b/.cursor/rules/README.mdc index 20288df..7088470 100644 --- a/.cursor/rules/README.mdc +++ b/.cursor/rules/README.mdc @@ -7,29 +7,33 @@ alwaysApply: false ### Purpose -This describes the overall design & architecture across code repositories. +This describes the overall purpose and design across code repositories. -The Endorser Server is a service that allows recording of cryptographically signed assertions in a privacy-preserving fashion. Each participant chooses whether to allow any other participant to see their name attached to activity. The service is a convenient way to get basic functions; we expect to provide direct P2P communications to support the same functionality for anyone who wants the alternative. +The Endorser Server is an HTTP API service that allows recording of cryptographically signed assertions in a privacy-preserving fashion. Each participant chooses whether to allow any other participant to see their name attached to activity. The service is a convenient way to get basic functions; we expect to provide direct P2P communications to support the same functionality for anyone who wants the alternative. -Time Safari is a front-end to make it intuitive and interesting to log self-asserted items, mainly of three kinds: +Web and mobile apps allow users to interact with the Endorser Server. The endorser-mobile project is a powerful interface but is not very user-friendly. -- Gives, recognizing something given +The Time Safari project (in the crowd-funder-for-time-pwa repository) is a front-end to make it intuitive and interesting to help people connect over activities. The intent is to enable people to find others with similar interests, to start activities and relationships via offers of help, and to encourage creative experiments for deeper and more widespread connections. -- Projects, which can then be the giver or recipient of gives +There are 3 kinds of actions in Time Safari: - Offers of help, to individuals or projects, which can be fulfilled by subsequent gives +- Gives, recognizing something given (whether time or physical goods) and the resulting impact + +- Projects, which aggregate offers and/or gives for a common purpose + ### Structure The primary repos contain the majority of the functionality; the secondary repos are helpful but not absolutely necessary. -These repos are found on the local filesystem in the same directory as this repo, in ../../../ from this file. +These repos are found on the local filesystem in the `repos` directory, ie. `../../repos` relative to this directory. Primary Repos: - endorser-ch is the back-end, written in Typescript -- crowd-funder-for-time-pwa is the front-end, written in Typescript with Vue & Vite, with deployments for mobile as well as web +- crowd-funder-for-time-pwa is the front-end named Time Safari, written in Typescript with Vue & Vite, with deployments for mobile as well as web Secondary Repos: @@ -51,6 +55,6 @@ Secondary Repos: - endorser-mobile is the previous native app to talk to the Endorser server -- very powerful but harder to use -These repos are located in GitHub: endorser-ch, endorser-mobile, lives-of-gifts uport-demo, endorser-docs, time-safari-web +These repos are hosted by GitHub: endorser-ch, endorser-mobile, lives-of-gifts uport-demo, endorser-docs, time-safari-web -The remaining repos are located at gitea.anomalistdesign.com +The remaining repos are hosted by gitea.anomalistdesign.com diff --git a/README.md b/README.md index 8220df6..292917b 100644 --- a/README.md +++ b/README.md @@ -1,8 +1,10 @@ # README-first -Context for all the technical info, mostly found in git repos +Context for all the technical info for Time Safari and the Endorser Search server. -See ./.cursor/rules/README.mdc +Other repos are located in the `repos` directory. + +For more details, see [the cursor rules README](./.cursor/rules/README.mdc). Kudos: diff --git a/repos b/repos new file mode 120000 index 0000000..a96aa0e --- /dev/null +++ b/repos @@ -0,0 +1 @@ +.. \ No newline at end of file