@@ -7,7 +7,7 @@ This repository hosts the backend API for the Vicinae extension store. It handle
77This backend application has been made very simple by design:
88- Hono as the main HTTP framework, lightweight and has support for all the good stuff
99- SQLITE as the database provider
10- - Local filesystem to store blobs such as uploaded extensions
10+ - Local filesystem to store blobs such as uploaded extensions, icons...
1111
1212The main idea is that the backend should be very easy to deploy on a single VPS and to backup.
1313Given what we use it for, it is good enough, and can still be upgraded to using a dedicated object storage or somehing like if necessary.
@@ -38,32 +38,3 @@ bun prisma migrate dev
3838``` sh
3939bun run dev
4040```
41-
42- The API will be available at http://localhost:3000
43-
44- ## API Endpoints
45-
46- - ` POST /extension/upload ` - Upload/update extensions (requires API_SECRET)
47- - ` GET /extensions/list ` - List extensions with pagination
48- - ` POST /extensions/download-callback ` - Track downloads
49- - ` GET /storage/* ` - Serve files (local storage only)
50-
51- See [ CLAUDE.md] ( ./CLAUDE.md ) for detailed API documentation.
52-
53- ## Storage
54-
55- The API uses local filesystem storage:
56- - Files stored in ` ./storage ` directory
57- - Served directly by the API via ` /storage/* ` endpoint
58- - Configure storage path and base URL via environment variables (see ` .env.example ` )
59-
60- ## Extension Format
61-
62- Extensions must:
63- - Be ZIP archives containing ` package.json ` at root
64- - Use ` @vicinae/api ` dependency (not ` @raycast/api ` )
65- - Pass manifest schema validation
66- - Be under 10MB (configurable)
67- - Target Linux platform
68-
69- Extension identity is determined by ` author + name ` combination.
0 commit comments