stacker.news/README.md

# 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.

# 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
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. More details [here](https://github.com/stackernews/stacker.news/tree/master/docs/local-auth.md). 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.

# license
[MIT](https://choosealicense.com/licenses/mit/)
update README 2021-06-28 23:20:52 +00:00			`# stacker.news`
update README 2023-02-03 19:09:06 +00:00			`[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.`

			`# 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.`
update README with docker instructions 2021-10-20 20:33:40 +00:00
			`# 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`

add instructions for testing with local auth 2023-03-24 16:32:42 +00:00			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. More details [here](https://github.com/stackernews/stacker.news/tree/master/docs/local-auth.md). If you have trouble please open an issue so I can help and update the README for everyone else.
Initial commit from Create Next App 2021-03-22 20:36:10 +00:00
update README 2021-06-28 23:20:52 +00:00			`# stack`
update README 2023-02-03 19:09:06 +00:00			`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.`
Initial commit from Create Next App 2021-03-22 20:36:10 +00:00
update README 2021-06-28 23:20:52 +00:00			`# processes`
add job queue 2022-01-05 20:37:34 +00:00			`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`
Initial commit from Create Next App 2021-03-22 20:36:10 +00:00
update README 2021-06-28 23:20:52 +00:00			`# 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.`
Initial commit from Create Next App 2021-03-22 20:36:10 +00:00
update README 2021-06-28 23:20:52 +00:00			`# code`
			`The code is linted with standardjs.`
Initial commit from Create Next App 2021-03-22 20:36:10 +00:00
update README 2021-06-28 23:20:52 +00:00			`# contributing`
			`Pull requests are welcome. Please submit feature requests and bug reports through issues.`
Initial commit from Create Next App 2021-03-22 20:36:10 +00:00
update README 2021-06-28 23:20:52 +00:00			`# license`
Update README.md 2022-04-04 17:21:32 +00:00			`[MIT](https://choosealicense.com/licenses/mit/)`