School E-Voting Platform with Next.js, TypeScript and TailwindCSS

This is a GitHub repository for a school e-voting platform built with Next.js, TypeScript and TailwindCSS. The platform aims to provide a secure and reliable online voting platform that can be used by schools for student-centric activities such as student leader elections, class representative voting and many more.

Prerequisites

To run this project, you will need the following:

• Node.js (version 10 or higher)
• yarn

Installation

1. Clone the repository or download the source code
2. Navigate to the project directory in your terminal
3. Run yarn install to install the required dependencies

Usage

After successfully installing the project, there are three commands available:

• npm run dev or yarn dev: Starts the development server and allows you to view the project in your browser at http://localhost:3000
• npm run build or yarn build: Builds the optimized production-ready code for deployment
• npm start or yarn start: Starts the production server to serve the optimized build generated from the previous step

Technologies Used

• Next.js: A server-side rendering React framework that allows for easy setup and configuration of a production-grade application with optimizations for performance and SEO.
• TypeScript: A statically typed language that provides robust type checking, code refactoring and allows for better code organization and maintainability.
• TailwindCSS: A utility-first CSS framework that provides a wide range of pre-built styles and components to make building responsive user interfaces quicker and more efficient.

Contributing

If you would like to contribute to the project, please follow these steps:

1. Create a fork of the project.
2. Create a new branch that reflects the feature or bug fix you will be working on.
3. Commit your changes to your new branch.
4. Create a pull request back to the original repository.