̣[QOL] - Add a new endpoint to get a single story with comments + various stuff... - Githubissues

attestate / kiwistand

kiwistand is a p2p node client for a web3 writer friendly Hacker News that nobody controls but everybody co-owns

https://news.kiwistand.com

GNU General Public License v3.0

63 stars 26 forks source link

̣[QOL] - Add a new endpoint to get a single story with comments + various stuff... #142

Closed noctisatrae closed 7 months ago

noctisatrae commented 7 months ago

Changes

In http.mjs, I created a new endpoint /story?index= to get a single story and comments.
I created a gen_db.mjs so new contributors can sync their node to the network without deleting lines from launch.mjs.
I edited the scripts section of package.json to add a new sync command to easily execute the gen_db.mjs with the right credentials from .env.
I added a contributing.md to onboard new contributors to the project.

Questions

I handle the error/send the data in my own custom way but I saw there is a sendStatus/sendError defined in api.mjs that I should maybe use, what about it?

TimDaub commented 7 months ago

Great work!

I rebased this into the main branch and deployed it to production; an example: https://news.kiwistand.com/api/v1/stories?index=0x662b7664865b28ee4afa5a7e409197853c43b84617e738bc6d09552c7b5547b278b1e085

For consistency with other endpoints, what I added is using the sendError and sendStatus functions, as you can see here: https://github.com/attestate/kiwistand/commit/e1862630ea25c6f5585244655890808700bdc6e5.

Thank you for contributing the contributing.md file. It will be helpful for newcomers, and I like the npm run sync command, which is an elegant way to make syncing with the tip of the chain much more accessible for anyone not familiar with the code base!