@haumea/namaka
v0.0.0-dev.9
Published
user comments and 5-star review system
Downloads
13
Maintainers
Readme
⁓ 🌑 namaka ⁓
namaka is a fullstack user comments and 5-star reviews system for web applications.
🕹️ live demo of namaka
📦 npm install @haumea/namaka
🛠️ typescript library and nodejs server
🌐 universal web components
💖 made with open source love, just for you
👨🏫 namaka devboard for tracking work and priorities
components and renderers
first-class components
<namaka-board>
a board that lists comments or reviews. every comment or review "belongs" to a board. each board has a "load more" button at the bottom, and sorting functionality.<namaka-comment>
display a comment. it might be a thread or a reply. it might also have a score (we call comments that have scores "reviews").<namaka-write-a-comment>
a user can author a new comment or review thread, and post it onto the board.<namaka-edit-comment>
a user can edit an existing comment or review, whether it be a thread, or a reply.<namaka-board-stats>
display interesting statistics about the given board's comments and reviews. statistics like the average review score, total number of comments, things like that.<namaka-bans>
displays a list of banned users (for admins).<namaka-demo>
helps developers test and work on namaka in "mock mode", without a real auth integration.
modal components
<namaka-modals>
in-viewport popups. these grab the user's attention, and requires them to take an action before allowing them to get back to the rest of the page.<namaka-ban>
confirm whether you want to ban a specific user, and provide a timeframe for how long you want the ban to last.<namaka-unban>
confirm whether you want to repeal a ban for a specific user.<namaka-archive-comment>
confirm whether you want to archive a specific comment. this appears to delete a comment.
utility components
<namaka-textarea>
a smart textarea input with validation functionality.
render functions
renderFiveStarDisplay
renders a 0 to 100 score as a five-star-rating.