Skip to content

Commit 7c4e6ee

Browse files
committed
feat: simplifiy README
1 parent 0539bb7 commit 7c4e6ee

File tree

1 file changed

+16
-10
lines changed

1 file changed

+16
-10
lines changed

README.md

Lines changed: 16 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -1,18 +1,24 @@
1-
# Vicinae Store Backend
1+
# Vicinae Backend
22

3-
This repository hosts the backend API for the Vicinae extension store. It handles extension submission, validation, storage, and discovery.
3+
Backend for the Vicinae extension store.
44

5-
## Architecture
5+
Currently hosted by [@aurelleb](https://github.com/aurelleb) on a [hetzner](https://www.hetzner.com/) VPS.
66

7-
This backend application has been made very simple by design:
8-
- Hono as the main HTTP framework, lightweight and has support for all the good stuff
9-
- SQLITE as the database provider
10-
- Local filesystem to store blobs such as uploaded extensions, icons...
7+
## Architecture
118

12-
The main idea is that the backend should be very easy to deploy on a single VPS and to backup.
13-
Given 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.
9+
The architecture of this service is very simple on purpose.
1410

15-
## Quick Start
11+
- Hono to serve web requests
12+
- Prisma + sqlite to maintain the list of available extensions in database
13+
- Assets and extension code stored on the local filesystem (could be easily moved to an actual object storage service if needed)
14+
15+
## Vicinae integration
16+
17+
The Vicinae extension store command makes requests to this backend service to retrieve extension-related content.
18+
19+
Vicinae does **not** contact the service outside of this command.
20+
21+
## Development
1622

1723
**Install dependencies:**
1824
```sh

0 commit comments

Comments
 (0)