hexmani.ac
social bookmarking for atproto
[meta] update READMEs
+39
-25
+12
-7
README.md
+12
-7
README.md
···
1
1
# clippr
2
2
3
-
social bookmarking for atproto
3
+
Social bookmarking for the AT Protocol.
4
4
5
5
## current status
6
6
7
-
we are currently working on completing the appview first before moving on to the frontend or any other packages.
7
+
Our current focus is on completing the AppView first before moving on in full earnest to the frontend or any other
8
+
packages; however, some may be developed in tandem if necessary.
8
9
9
-
a lexicon package is available for those using atcute, however, it is still under heavy development. we do not recommend
10
-
using it in any way until the appview is ready.
10
+
The AppView currently has support for indexing records that are created, updated or deleted, some basic queries and DID
11
+
service proxying. Authenticated endpoints and most other queries are currently not implemented.
12
+
13
+
The frontend has OAuth authentication and the ability to view and edit profiles, but is otherwise empty.
11
14
12
-
the frontend has no interactivity and is basically just a mockup.
15
+
A lexicon package is available for those using [atcute](https://github.com/mary-ext/atcute), but it is still under
16
+
heavy development. We do not recommend
17
+
using it in any production environment until the AppView is functionally complete.
13
18
14
19
## what's in here?
15
20
16
-
the project is sorted into different sections, with each root-level folder signifying a package.
21
+
The project is sorted into different sections, with each root-level folder signifying a package.
17
22
18
-
each section will usually contain its own README.md file dedicated to it, going into more detail about that specific
23
+
Each section will usually contain its own README.md file dedicated to it, going into more detail about that specific
19
24
package.
20
25
21
26
| package | description |
+16
-16
backend/README.md
+16
-16
backend/README.md
···
1
1
# @clipprjs/server
2
2
3
-
typescript implementation of clippr appview using ~~bun~~ deno and hono
3
+
TypeScript implementation of the Clippr AppView, using ~~bun~~ NodeJS and Hono.
4
4
5
-
## run and develop
5
+
> ## Why not Bun?
6
+
> We currently aren't using Bun due to some compatibility errors. A migration to Bun is planned in the future,
7
+
> preferably before launch.
8
+
9
+
## Start development server
6
10
7
11
```shell
8
12
pnpm install
13
+
cp config.example.toml config.toml # Customize as necessary
9
14
pnpm run db:push
10
15
pnpm run dev
11
16
```
12
17
13
-
open http://localhost:9090 and enjoy
18
+
Open http://localhost:9090 and enjoy
14
19
15
-
## build for production
20
+
## Build for production
16
21
17
22
```shell
18
23
pnpm install
24
+
cp config.example.toml config.toml # Customize as necessary
19
25
pnpm run db:push
20
26
pnpm run build
21
27
pnpm run start
···
23
29
24
30
## current status
25
31
26
-
right now we're not running on bun because there are
27
-
[some issues with partysocket](https://github.com/oven-sh/bun/issues/18807), which haven't been
28
-
fixed yet and which the jetstream library we use depends on for the moment. once it has been fixed,
29
-
we do plan to use bun over node in the future.
30
-
31
-
### checklist before it's usable
32
-
33
32
- ✅ Ingesting content from the firehose (using Jetstream)
34
-
- ✅ Creating the lexicon documents and validating content that comes in from the firehose
33
+
- ✅ Validating incoming content according to the Lexicon schema
35
34
- ✅ Indexing valid content from the firehose into a database
36
-
- Handling OAuth authentication (public OAuth for the moment)
37
-
- Creating responses to API calls
38
-
- Create records through the API
39
-
- Interact with the frontend
35
+
- ✅ Support for DID service proxying and Nodeinfo
36
+
- 🟡 API documentation
37
+
- 🟡 Creating responses to unauthenticated API calls
38
+
- 🟡 Interactions with the frontend
39
+
- 🔴 Creating responses to authenticated API calls
+10
-1
frontend/README.md
+10
-1
frontend/README.md
···
4
4
5
5
## development
6
6
7
+
If you are testing the frontend in conjunction with the AppView, you might want to change the following:
8
+
9
+
* OAuth automatically adapts to whether the frontend is built or in dev mode.
10
+
* ``VITE_CLIPPR_APPVIEW`` is set to the defaults for both production and development, however, if you are hosting the
11
+
appview from another location, you will need to change this.
12
+
7
13
```shell
8
14
pnpm install
9
-
cp .env.example .env # Modify this if necessary
10
15
pnpm run dev
11
16
```
12
17
13
18
## deployment
19
+
20
+
If you plan to deploy the frontend and use another AppView or to add/remove OAuth scopes, you will have to modify
21
+
``public/oauth/client-metadata.json`` and the ``VITE_CLIPPR_APPVIEW`` environment variable. There are plans to add a way
22
+
to change what AppView DID the frontend proxies its requests to inside the frontend, but not before launch.
14
23
15
24
```shell
16
25
pnpm run build