README.md

Election Management System

📗 Table of Contents

• 📖 About the Project
  • 🛠 Built With
    • Tech Stack
    • Key Features
  • 🚀 Live Demo
• 💻 Getting Started
  • Prerequisites
  • Setup
  • Install
  • Usage
  • Deployment
• 👥 Authors
• 🔭 Future Features
• 🤝 Contributing
• ⭐️ Show your support
• ❓ FAQ
• 📝 License

📊Election Management System

Election Management System is an app where polling agents can manage election results and users can view live results

🛠 Built With

Tech Stack

Client

• Ejs

Server

• Express.js

Database

• Mongo DB

Key Features

• Polling agents can log in to the system using their credentials to access certain features
• Polling Agents can View all records, add new record, edit and delete the records
• The application tracks votes for multiple political parties in each polling unit
• Visitors can search for election results by entering the ID of a specific polling unit. The application retrieves and displays the results, including the total votes cast and the individual party-wise votes for that particular polling unit.

(back to top)

🚀 Live Demo

• Election Management System

(back to top)

💻 Getting Started

To get a local copy up and running, follow these steps.

Prerequisites

In order to run this project you need:

• Node
• NPM or Yarn
• Mongo DB account

Setup

Clone this repository to your desired folder:

  cd your-folder
  git clone https://github.com/ceeriil/election-management.git

Install

Install this project with:

 npm install
 npm install -g nodemon

Usage

To run the project, execute the following command:

  nodemon app.js

Then Open URL "https://localhost:3000" on a browser.

Deployment

You can deploy the program on any hosting service supporting express js

(back to top)

👥 Authors

👤 Simon Cyril

• GitHub: @ceeriil
• Twitter: @ceeriil

👤 Emma Ochonogor

• GitHub: @Emmah-oo

(back to top)

🔭 Future Features

Features I would love to add in the future

• Multiple agent Login: Multiple agents should be able to login with their unique details
• Mobile Responsiveness
• Integration with Blockchain

(back to top)

🤝 Contributing

Contributions, issues, and feature requests are welcome!

Feel free to check the issues page.

(back to top)

⭐️ Show your support

If you like this project feel free to message me on twitter

(back to top)

❓ FAQ

• How do I set up mongo db database with the app

  • Create a .env file in the root directory
  • Signin/up to https://www.mongodb.com/cloud/atlas/register
  • Create a cluster and connect it to the application.

    PORT = 3000
    DATABASE ='yourdatabasestring'
    SECRET = 'YourSecretKey'

• How do I log in as a polling agent

  • Message me on twitter to get the login info for the polling agent database

(back to top)

📝 License

This project is MIT licensed.

(back to top)