diddyfo.id
social bookmarking for atproto
1# clippr
2
3Social bookmarking for the AT Protocol.
4
5## current status
6
7Our current focus is on completing the AppView first before moving on in full earnest to the frontend or any other
8packages; however, some may be developed in tandem if necessary.
9
10The AppView currently has support for indexing records that are created, updated or deleted, some basic queries and DID
11service proxying. Authenticated endpoints and most other queries are currently not implemented.
12
13The frontend has OAuth authentication and the ability to view and edit profiles, but is otherwise empty.
14
15A lexicon package is available for those using [atcute](https://github.com/mary-ext/atcute), but it is still under
16heavy development. We do not recommend
17using it in any production environment until the AppView is functionally complete.
18
19## what's in here?
20
21The project is sorted into different sections, with each root-level folder signifying a package.
22
23Each section will usually contain its own README.md file dedicated to it, going into more detail about that specific
24package.
25
26| package | description |
27|--------------------------------------------------------------------------|---------------------------------------------------|
28| [``backend``](https://tangled.sh/@hexmani.ac/clippr/tree/main/backend) | The reference AppView written using Node and Hono |
29| [``frontend``](https://tangled.sh/@hexmani.ac/clippr/tree/main/frontend) | The reference client written in Solid |
30| [``lexdocs``](https://tangled.sh/@hexmani.ac/clippr/tree/main/lexdocs) | The original Lexicon files |
31| [``lexicons``](https://tangled.sh/@hexmani.ac/clippr/tree/main/lexicons) | An atcute package for the clippr lexicons |
32
33## roadmap
34
35soon™️
36
37## license
38
39All project code is licensed as free software under the
40[**GNU Affero General Public License**](https://tangled.sh/@hexmani.ac/clippr/blob/main/LICENSE), exclusively under
41version 3. However, the Lexicon schema files are licensed under the permissive
42[**MIT License**](https://tangled.sh/@hexmani.ac/clippr/blob/main/lexdocs/LICENSE) to encourage forks and to allow them
43to be used in projects that are incompatible with the AGPL.