Krish-Panchani/clickvote

Add upvotes, likes, and reviews to any context ⭐️

Add upvotes, likes, and reviews to any context

Explore the docs »

Visit the website | Register to the cloud | Read the docs | Self-hosting quick start guide

Clickvote participate in Hacktoberfest 2023!

Make three valuable PRs (no typo) and win this awesome Clickvote tee!
Maximum ten tees! So hurry up!

Clickvote

Clickvote takes the hassle of building your own reaction components around your content.

• Showing real-time updates of likes, upvotes, and reviews between clients.
• Learn about your members through deep analytics.
• Deal with an unlimited amount of clicks per second.

Requirements

Please make sure you have installed:

• Redis
• Mongodb

Quickstart

Clone the project, run:

npm run setup

It will ask you add your environment variables, in most cases you can just use the default option

To run the backend and frontend, run:

npm run web

To run the websockets and worker, run:

npm run upvotes

To modify the react component, run:

npm run dev:react-component

Add your react component to the user application

You can find examples of how to use the React component here:

https://github.com/clickvote/clickvote/tree/main/libs/react-component/src/lib/examples

STILL UNDER DEVELOPMENT

---

---

---