hexmani.ac
social bookmarking for atproto
[meta] update some readmes
+48
-21
+23
-5
README.md
+23
-5
README.md
···
2
2
3
3
social bookmarking for atproto
4
4
5
+
## current status
6
+
7
+
we are currently working on completing the appview first before moving on to the frontend or any other packages.
8
+
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.
11
+
12
+
the frontend has no interactivity and is basically just a mockup.
13
+
5
14
## what's in here?
6
15
7
-
the project is sorted into four directories, comprised of:
16
+
the project is sorted into different sections, with each root-level folder signifying a package.
8
17
9
-
* ``backend`` - the reference appview written using node and hono
10
-
* ``frontend`` - the reference frontend written in astro and typescript
11
-
* ``lex-src`` - the original lexicon files
12
-
* ``lexicons`` - an atcute package for the clippr lexicon
18
+
each section will usually contain its own README.md file dedicated to it, going into more detail about that specific
19
+
package.
20
+
21
+
| package | description |
22
+
|--------------------------------------------------------------------------|------------------------------------------------------|
23
+
| [``backend``](https://tangled.sh/@hexmani.ac/clippr/tree/main/backend) | the reference appview written using node and hono |
24
+
| [``frontend``](https://tangled.sh/@hexmani.ac/clippr/tree/main/frontend) | the reference client written in astro and typescript |
25
+
| [``lexdocs``](https://tangled.sh/@hexmani.ac/clippr/tree/main/lexdocs) | the original lexicon files |
26
+
| [``lexicons``](https://tangled.sh/@hexmani.ac/clippr/tree/main/lexicons) | an atcute package for the clippr lexicons |
27
+
28
+
## roadmap
29
+
30
+
soon™️
+22
-11
backend/README.md
+22
-11
backend/README.md
···
1
-
# clippr-be
1
+
# @clipprjs/server
2
2
3
3
typescript implementation of clippr appview using ~~bun~~ deno and hono
4
4
5
5
## run and develop
6
6
7
-
```sh
7
+
```shell
8
8
pnpm install
9
+
pnpm run db:push
9
10
pnpm run dev
10
11
```
11
12
12
13
open http://localhost:9090 and enjoy
13
14
15
+
## build for production
16
+
17
+
```shell
18
+
pnpm install
19
+
pnpm run db:push
20
+
pnpm run build
21
+
pnpm run start
22
+
```
23
+
14
24
## current status
15
25
16
26
right now we're not running on bun because there are
17
-
[some issues with the jetstream library](https://github.com/oven-sh/bun/issues/18807), which haven't
18
-
been fixed yet.
27
+
[some issues with partysocket](https://github.com/oven-sh/bun/issues/18807), which haven't
28
+
been fixed yet and which the jetstream library we use depends on for the moment. once it has been fixed, we do plan
29
+
to use bun over node in the future.
19
30
20
31
### checklist before it's usable
21
32
22
-
- [x] Ingesting content from the firehose (using Jetstream)
23
-
- [x] Creating the lexicon documents and validating content that comes in from the firehose
24
-
- [x] Indexing valid content from the firehose into a database
25
-
- [ ] Handling OAuth authentication (public OAuth for the moment)
26
-
- [ ] Creating responses to API calls
27
-
- [ ] Create records through the API
28
-
- [ ] Interact with the frontend
33
+
- ✅ Ingesting content from the firehose (using Jetstream)
34
+
- ✅ Creating the lexicon documents and validating content that comes in from the firehose
35
+
- ✅ 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
+2
-2
frontend/README.md
+2
-2
frontend/README.md
+1
-3
lexicons/README.md
+1
-3
lexicons/README.md
···
2
2
3
3
Lexicon package auto-generated with `@atcute/lex-cli`
4
4
5
-
> [!WARNING]
6
5
> This package is *very* unstable. Lexicon attributes can be modified at any moment.
7
6
> Please do not use this package for anything until the [Clippr server](https://tangled.sh/@hexmani.ac/clippr) has been
8
-
> deployed.
7
+
> deployed for either public or developer consumption.
9
8
10
9
## Usage
11
10
12
-
> [!NOTE]
13
11
> This section has been shamelessly lifted from
14
12
> the [atcute definitions](https://github.com/mary-ext/atcute/tree/trunk/packages/definitions/bluesky) packages. We
15
13
> recommend using this package with other atcute libraries for maximum compatibility.