388e00dd04
* npm uninstall next-pwa next-pwa was last updated in August 2022. There is also an issue which mentions that next-pwa is abandoned (?): https://github.com/shadowwalker/next-pwa/issues/482 But the main reason for me uninstalling it is that it adds a lot of preconfigured stuff which is not necessary for us. It even lead to a bug since pages were cached without our knowledge. So I will go with a different PWA approach. This different approach should do the following: - make it more transparent what the service worker is doing - gives us more control to configure the service worker and thus making it easier * Use workbox-webpack-plugin Every other plugin (`next-offline`, `next-workbox-webpack-plugin`, `next-with-workbox`, ...) added unnecessary configuration which felt contrary to how PWAs should be built. (PWAs should progressivly enhance the website in small steps, see https://web.dev/learn/pwa/getting-started/#focus-on-a-feature) These default configurations even lead to worse UX since they made invalid assumptions about stacker.news: We _do not_ want to cache our start url and we _do not_ want to cache anything unless explicitly told to. Almost every page on SN should be fresh for the best UX. To achieve this, by default, the service worker falls back to the network (as if the service worker wasn't there). Therefore, this should be the simplest configuration with a valid precache and cache busting support. In the future, we can try to use prefetching to improve performance of navigation requests. * Add support for Web Share Target API See https://developer.chrome.com/articles/web-share-target/ * Use Web Push API for push notifications I followed this (very good!) guide: https://web.dev/notifications/ * Refactor code related to Web Push * Send push notification to users on events * Merge notifications * Send notification to author of every parent recursively * Remove unused userId param in savePushSubscription As it should be, the user id is retrieved from the authenticated user in the backend. * Resubscribe user if push subscription changed * Update old subscription if oldEndpoint was given * Allow users to unsubscribe * Use LTREE operator instead of recursive query * Always show checkbox for push notifications * Justify checkbox to end * Update title of first push notification * Fix warning from uncontrolled to controlled * Add comment about Notification.requestPermission * Fix timestamp * Catch error on push subscription toggle * Wrap function bodies in try/catch * Use Promise.allSettled * Filter subscriptions by user notification settings * Fix user notification filter * Use skipWaiting --------- Co-authored-by: ekzyis <ek@stacker.news> |
||
---|---|---|
.ebextensions | ||
.github | ||
.platform | ||
.vscode | ||
api | ||
components | ||
docs | ||
fragments | ||
lexical | ||
lib | ||
pages | ||
prisma | ||
public | ||
spawn | ||
styles | ||
svgs | ||
sw | ||
worker | ||
.babelrc | ||
.env.sample | ||
.gitignore | ||
.npmrc | ||
.puppeteerrc.cjs | ||
Dockerfile | ||
LICENSE | ||
Procfile | ||
README.md | ||
docker-compose.yml | ||
middleware.js | ||
next.config.js | ||
package-lock.json | ||
package.json |
README.md
contributing
We pay sats for PRs. Sats will be proportional to the impact of the PR. If there's something you'd like to work on, suggest how much you'd do it for on the issue. If there's something you'd like to work on that isn't already an issue, whether its a bug fix or a new feature, create one.
responsible disclosure
If you found a vulnerability, we would greatly appreciate it if you contact us via kk@stacker.news or t.me/k00bideh.
stacker.news
Stacker News is like Hacker News but we pay you Bitcoin. We use Bitcoin and the Lightning Network to provide Sybil resistance and any karma earned is withdrawable as Bitcoin.
wen decentralization
We're experimenting with providing an SN-like service on nostr in Outer Space. It's our overarching goal to align SN with Bitcoin's ethos yet still make a product the average bitcoiner loves to use.
local development
- Install docker-compose and deps if you don't already have it installed
git clone git@github.com:stackernews/stacker.news.git sn && cd sn
docker-compose up --build
You should then be able to access the site at localhost:3000
and any changes you make will hot reload. If you want to login locally or use lnd you'll need to modify .env.sample
appropriately. More details here and here. If you have trouble please open an issue so I can help and update the README for everyone else.
stack
The site is written in javascript using Next.js, a React framework. The backend API is provided via graphql. The database is postgresql modelled with prisma. The job queue is also maintained in postgresql. We use lnd for our lightning node. A customized Bootstrap theme is used for styling.
processes
There are two. 1. the web app and 2. the worker, which dequeues jobs sent to it by the web app, e.g. polling lnd for invoice/payment status
wallet transaction safety
To ensure user balances are kept sane, all wallet updates are run in serializable transactions at the database level. Because prisma has relatively poor support for transactions all wallet touching code is written in plpgsql stored procedures and can be found in the prisma/migrations folder.
code
The code is linted with standardjs.