0c2b9a31b2 | ||
---|---|---|
.ebextensions | ||
.github | ||
.platform | ||
.vscode | ||
api | ||
components | ||
fragments | ||
lexical | ||
lib | ||
pages | ||
prisma | ||
public | ||
spawn | ||
styles | ||
svgs | ||
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
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 discussing if it's possible to provide SN on nostr and/or a hybrid approach and have plans to begin experimenting with it. 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. 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.
contributing
Pull requests are welcome. Please submit feature requests and bug reports through issues.