Go to file
keyan ad40092fcd include rewards in top/users 2022-07-14 12:08:58 -05:00
.ebextensions fix onion dir 2022-07-12 12:36:58 -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 add earning to top stacking users 2022-07-13 19:55:10 -05:00
components improved heading and images for markdown 2022-07-13 19:54:55 -05:00
fragments better reward notifications 2022-07-05 15:18:59 -05:00
lib limit title length to 80 characters 2022-07-13 10:49:55 -05:00
pages improved heading and images for markdown 2022-07-13 19:54:55 -05:00
prisma improve trust 2022-07-05 14:51:13 -05:00
public WIP profiles 2022-05-05 15:39:05 -05:00
spawn delay capture because font isn't loading 2022-02-03 13:41:09 -06:00
styles refine reply-only notifications 2022-04-21 12:48:27 -05:00
svgs Merge pull request #161 from kerooke/patch-2 2022-06-08 16:22:28 -05:00
worker make earning more tangible 2022-07-07 14:26:51 -05: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
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 sort by top posts 2021-10-21 17:05:06 -05:00
next.config.js update CORS on static assets 2022-07-10 18:24:59 -05:00
package-lock.json add usage mvp usage charts 2022-06-10 14:20:33 -05:00
package.json add usage mvp usage charts 2022-06-10 14:20:33 -05: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