28 lines
1.8 KiB
Markdown
28 lines
1.8 KiB
Markdown
# stacker.news
|
|
[Stacker News](https://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](https://docs.docker.com/compose/install/) 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](https://choosealicense.com/licenses/mit/)
|