Go to file
keyan 8e857fd8a7 build on config change 2022-02-23 11:35:54 -06:00
.ebextensions try to fix nginx issues on config deploy 2022-02-21 13:09:41 -06:00
.github Update FUNDING.yml 2021-09-15 14:25:30 -05:00
.platform build on config change 2022-02-23 11:35:54 -06:00
.vscode working comments with cache updates 2021-04-17 13:15:18 -05:00
api prevent top item/comment gaming with WoT 2022-02-12 09:08:39 -06:00
components don't build on config updates 2022-02-23 11:20:51 -06:00
fragments search highlighting 2022-02-03 16:01:42 -06:00
lib fix user posts/comments fetchMore 2022-01-30 11:43:22 -06:00
pages add search SEO and capture 2022-02-05 11:29:41 -06:00
prisma search index triggers 2022-01-26 11:03:21 -06:00
public readability enhancements: text size/color/line height 2022-02-09 13:15:38 -06:00
spawn delay capture because font isn't loading 2022-02-03 13:41:09 -06:00
styles fix cls of twitter embed 2022-02-12 08:06:41 -06:00
svgs search bar ui 2022-01-26 15:43:18 -06:00
worker index item path in search 2022-01-28 13:19:56 -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 dockerize dev env 2021-10-20 14:57:11 -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 add job queue 2022-01-05 14:37:34 -06:00
docker-compose.yml sort by top posts 2021-10-21 17:05:06 -05:00
next.config.js add lightning font 2022-01-21 12:58:21 -06:00
package-lock.json fix cls of twitter embed 2022-02-12 08:06:41 -06:00
package.json fix cls of twitter embed 2022-02-12 08:06:41 -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 decentralize 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