Medium-roast is an API based on HackerNews created by ycombinator.
- I built this project to provide a more accessible API for HN; a sister project of hn-go, which runs on a local cache structure.
- Medium-roast ingests and creates a local database of http response data from HN's firebase API.
- Using this code structure, I focused on cleaning up the data to be friendlier for clients to parse with minimal fetching on their part.
- Learned concepts: Chunked API responses, Postgres interactions, ES Modules.
- Postgres DB to persist data from fetches to reduce network traffic.
- Implement chunked http processing.
- Focus on cyclic complexity to break apart large logic structures.
TODO
- Refresh on interval to add new Stories.
- Implement root level logging.
- Finish consume function for recursive comment or expand DB schemas.
You should provide a .environment with a connection string under the variable DATABASE_URL.
Initialize Prisma with npx prisma init --datasource-provider postgresql Migrate Models to Database with npx prisma migrate dev --name init
To run locally use npm run dev in your terminal.
Go to http://localhost:8000/secretingest to ingest the initial data.
If you change the Models remember to run npx prisma db push to update your DB tables.
If you have any issues with prisma, you can run npx prisma db reset to get fresh tables.
If you have JSdoc installed globally, use jsdoc controllers -r -d docs to update the static html.
Please veiw the issues tab or open a discussion for non-listed issues. Adhere to the Contributor Covenant