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.
- 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. 🚫🗳️
- 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) 🚀
- Backend: Node.js, Express, MongoDB
- Frontend: Vite (React), JavaScript/TypeScript
- Database: MongoDB
- Real-Time Updates: WebSockets (optional)
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.
Make sure you have the following installed:
- Node.js (v14 or higher)
- npm or yarn
- MongoDB (running locally or hosted)
- Fork this repository to your own GitHub account.
- Clone the forked repository to your local machine.
git clone https://github.com/your-username/voting-app.git- Navigate to the project directory.
cd voting-app- Navigate to the backend-server directory.
cd backend-server- Install the required dependencies.
npm install- Start the server.
node index.js- Navigate to the frontend-server directory separately.
cd frontend-voting- Install the required dependencies.
npm install- Start the server.
npm run devBackend is runnig on: http://localhost:5000
Frontend is runnig on: http://localhost:5432
Contributions are welcome! To contribute:
- Fork the repository. 🍴
- Create a new branch (git checkout -b feature-branch). 🌳
- Make your changes. ✏️
- Commit your changes (git commit -m 'Add new feature'). 💾
- Push to the branch (git push origin feature-branch). 📤
- Open a Pull Request. 🔄
- 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! 🚀✨
This project is licensed under the MIT licensed. See the LICENSE file for details.