skartik-sk/Hect-PollQ

A global poll conducting platform. Which conducts poll events seamlessly with full encryption.

Voting App (pollQ)

An online platform conducting voting system online!

Stars	🍴 Forks	Issues	Open PRs	Closed PRs

Featured In

Project Overview

It is an online platform which enables users to create, manage, and participate in voting events.

Tech Stack

Welcome to the Voting App repository! This project allows users to create, manage, and participate in voting events. The app is built with a Node.js backend and a Vite-powered frontend, designed for efficient performance and modern development workflows. This application is fully open source, so feel free to contribute or adapt it to your own needs.

Scope for this project

• Creation of UI/UX (This is the major part). 🎨
• Figma design will also work. 🖌️
• Ideas for the scope of this project (Must be written in IDEAS.md file). 💡
• Creation of backend/database. 🗄️
• Creation of frontend (Majorly dark theme). 🌙
• How to scale is globally. 🌍
• Restrictions to user. User should be able to vote once per poll event. 🚫🗳️

Table of Contents

• Features
• Tech Stack
• Project Structure
• Setup Instructions
  • Backend Setup
  • Frontend Setup
• Contributing
• Note
• License

Features

• User authentication (Login/Register) 🔑
• Create and manage polls 🗳️
• Real-time vote updates ⚡
• Responsive and intuitive user interface 📱
• Data persistence with MongoDB 💾
• Backend REST API built with Node.js 🖥️
• Frontend built with Vite (React/Vite, as applicable) 🚀

Tech Stack

• Backend: Node.js, Express, MongoDB
• Frontend: Vite (React), JavaScript/TypeScript
• Database: MongoDB
• Real-Time Updates: WebSockets (optional)

Project Structure

The project is divided into two main folders:

• Backend-server: This contains the Node.js application code that serves as the API layer, handling user authentication, poll creation, and voting logic.
• Frontend-server: This contains the client-side code built using Vite, providing a modern interface for users to interact with the application.

Setup Instructions

Prerequisites

Make sure you have the following installed:

• Node.js (v14 or higher)
• npm or yarn
• MongoDB (running locally or hosted)

Get Started

Setting up repository

1. Fork this repository to your own GitHub account.
2. Clone the forked repository to your local machine.

 git clone https://github.com/your-username/voting-app.git

3. Navigate to the project directory.

 cd voting-app

Backend Setup

1. Navigate to the backend-server directory.

 cd backend-server

2. Install the required dependencies.

 npm install

3. Create a .env file in the backend-server directory and add the following variables

 MONGODB_URI = your mongodb uri of the new mongo db you created for this project
 PORT = your preferred port

4. Start the server.

 node index.js

Frontend Setup

1. Navigate to the frontend-server directory separately.

 cd frontend-voting

2. Install the required dependencies.

 npm install

3. Start the server.

 npm run dev

Backend is runnig on: http://localhost:5000

Frontend is runnig on: http://localhost:5432

Git Setup and Installation

To contribute to the PollQ repository, follow these steps:

1. Fork the Repository: Click on the "Fork" button on the repository's GitHub page to create a copy of the repository in your GitHub account.

2. Clone the repository: Clone the forked repository to your local machine using the following command in your terminal.

   git clone https://github.com/<your-github-username>/PollQ

3. Add a remote upstream:

   git remote add upstream https://github.com/original-owner-username/PollQ

4. Create a new branch: Create a new branch for your changes. Run the following command in your terminal.

   git checkout -b <your-branch-name>

5. Make the desired changes: Make the desired changes to the source code.

6. Add your changes: Add your changes to the staging area. Run the following command in your terminal.

   git add <File1 changed> <File2 changed> ...

7. Commit your changes: Commit your changes with a meaningful commit message. Run the following command in your terminal.

   git commit -m "<your-commit-message>"

8. Push your changes: Push your changes to your forked repository. Run the following command in your terminal

   git push origin <your-branch-name>

9. Create a Pull Request: Go to the GitHub page of your forked repository. You should see a prompt to create a pull request (PR). Click on it, compare the changes, and create the PR.
   
   

Contributing

We love your input! We want to make contributing to this project as easy and transparent as possible, whether it's.

To contribute to the Retro repository using GitHub Desktop, follow these steps:

Reporting a bug
Discussing the current state of the code
Submitting a fix
Proposing new features

To get started with contributing, please follow the steps outlined in the Contributing.md.

Our Contributors

Thank you for contributing to our repository

Show some by starring this awesome repository!

If you find this project helpful, please consider giving it a star!

Note:

• We encourage you to raise any issues or suggestions you may have! Your feedback is valuable! 🙌
• Let’s embark on this journey together and make it a fun and enriching learning experience for everyone! 🚀✨

License

This project is licensed under the MIT licensed. See the LICENSE file for details.