cellar/cs-docs
4
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

docs: added technical design #3

Merged
y merged 4 commits from technical-design into main 2025-03-24 07:51:38 +00:00
Conversation 2 Commits 4 Files Changed 3 +44 -8
3 changed files with 44 additions and 8 deletions
Showing only changes of commit c7f549b5c8 - Show all commits

32
technical-design-assets/technical-design.drawio

File diff suppressed because one or more lines are too long

2
technical-design-assets/technical-design.svg

File diff suppressed because one or more lines are too long
Side by Side

After

(image error) Size: 3.5 MiB

18
technical-design.md

@ -1,8 +1,8 @@
# Cellar Social Technical Design
# rCellar Social Technical Design
## Description
Sellar Social is a platform where aficionados of international wine, sake, spirits and coffee can review, discuss, and order it.
Cellar Social is a platform where admirers of international wine, sake, spirits and coffee can review, discuss, and order it.
## Key Features
@ -27,11 +27,11 @@ Cellar Social will provide the following capabilities:
## Design
Cellar Cocial consists of the backend and frontend apps supported by the database and the relay.
Cellar Social consists of the backend and frontend apps supported by the database and the relay.
All services will be deployed to the linux ([Ubuntu](https://ubuntu.com/)) server and traffic routing will be manged by [Nginx](https://nginx.org/). The entire server should be backed up daily.
All hosted services will be containerised and deployed to the linux ([Ubuntu](https://ubuntu.com/)) server and traffic routing will be manged by [Nginx](https://nginx.org/). The entire server should be backed up daily.
y marked this conversation as resolved Outdated
b commented 2025-03-21 13:51:51 +00:00
Outdated
Review

Backups will happen at the host level, right?

Backups will happen at the host level, right?
y commented 2025-03-21 14:34:38 +00:00
Outdated
Review

yes

yes
Cellar Social will also use external service for media hosting to avoid inappropriate data.
Cellar Social will also use an external service ([nostr.build](http://nostr.build/)) for media hosting to avoid inappropriate data.
![Alt text](./technical-design-assets/technical-design.svg)
@ -49,6 +49,10 @@ Cellar Social will also use external service for media hosting to avoid inapprop
`Npub Whitelist` - collection of whitelisted Npubs
`Nostr Communication Platform` - flotilla.social is planned to be usedas a communication platform over Nostr
`Shopstr Marketplace` - shopstr.store is planned to be used as a Nostr marketplace
### Frontend
The frontend app (`Client`) is a web application that users will be able to use by visiting a URL via browser (browsers list is not defined at the moment). The app will be built using the following technologies:
y marked this conversation as resolved Outdated
b commented 2025-03-21 13:55:27 +00:00
Outdated
Review

is it worth mentioning the NDK, or the library we'll implement?

is it worth mentioning the NDK, or the library we'll implement?
y commented 2025-03-21 14:37:12 +00:00
Outdated
Review

potentially we'll use not just NDK, but nostr-tools or applesouce too. I would say it is more implementation details.

potentially we'll use not just NDK, but nostr-tools or applesouce too. I would say it is more implementation details.
@ -99,6 +103,10 @@ Database has to be backed up daily.
Npub whitelisting has to be enabled for strict relay access.
y marked this conversation as resolved
b commented 2025-03-21 14:01:07 +00:00
Review

used because of their excellent service and safety protections. Users can make use of their existing nostr.build subscriptions when they upload content.

link: https://nostr.build/features/

used because of their excellent service and safety protections. Users can make use of their existing nostr.build subscriptions when they upload content. link: https://nostr.build/features/
`APP Relay` will be available for communication at flotilla.social (users' npubs will be taken into account).
Multiple Shopstr instances will use the `APP Relay` to read and write data. Each Shopstr instance will have a dedicated subdomain at Cellar Social.
### Media Server
[nostr.build](https://nostr.build/) will be used as a media server. It is used to avoid inappropriate data while media uploads.