Go to file
keyan 9c0ead308b remove debug logging 2023-01-13 13:19:42 -06:00
.ebextensions log tor to own file 2022-09-06 12:07:12 -05:00
.github Update FUNDING.yml 2021-09-15 14:25:30 -05:00
.platform add Onion-Location header 2022-07-12 13:18:12 -05:00
.vscode remove vscode settings 2022-06-08 16:56:35 -05:00
api remove debug logging 2023-01-13 13:19:42 -06:00
components remove debug logging 2023-01-13 13:19:42 -06:00
fragments delete 2023-01-13 11:52:18 -06:00
lexical fix blockquote spacing 2023-01-05 19:06:31 -06:00
lib delete 2023-01-13 11:52:18 -06:00
pages delete 2023-01-13 11:52:18 -06:00
prisma delete 2023-01-13 11:52:18 -06:00
public global modal + small fixes/enhancements 2023-01-10 17:13:37 -06:00
spawn upgrade deps 2022-11-06 11:28:58 -06:00
styles global modal + small fixes/enhancements 2023-01-10 17:13:37 -06:00
svgs lightning login copy 2023-01-10 12:55:17 -06:00
worker delete 2023-01-13 11:52:18 -06:00
.babelrc dark mode with css variables instead 2021-11-09 16:43:56 -06:00
.env.sample fix invites 2021-11-11 11:38:41 -06:00
.gitignore improve trust 2022-07-05 14:51:13 -05:00
.npmrc unsafe perm test 2021-06-04 19:54:03 -04:00
.puppeteerrc.cjs puppeteer config 2022-11-16 10:57:03 -06:00
Dockerfile dockerize dev env 2021-10-20 14:57:11 -05:00
LICENSE add license 2021-06-28 18:28:26 -05:00
Procfile remove check from procfile 2022-01-09 11:57:15 -06:00
README.md Update README.md 2022-04-04 12:21:32 -05:00
docker-compose.yml Created new image for worker, running work script on startup 2022-10-06 15:33:18 -05:00
middleware.js referrals 2022-12-19 16:27:52 -06:00
next.config.js allow nip05 for users 2023-01-06 18:53:29 -06:00
package-lock.json unshorten links 2023-01-12 12:05:47 -06:00
package.json unshorten links 2023-01-12 12:05:47 -06:00

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. Next year we plan to begin decentralizing SN on an open peer to peer network.

local development

  1. Install docker-compose and deps if you don't already have it installed
  2. git clone git@github.com:stackernews/stacker.news.git sn && cd sn
  3. 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 the lightning node which we connect to through a tor http tunnel. 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.

license

MIT