Bunk-Mate (Website)

Bunk-Mate is an attendance tracker designed to help users track and plan their bunks effectively. Whether you're a student managing your attendance or someone who needs a system to stay on top of absences, Bunk-Mate provides a simple and intuitive solution.
This repository contains the source code and documentation for Bunk-Mate.

Features

• Track Attendance: Monitor your attendance in different subjects.
• Plan Bunks: Stay informed of how many classes you can safely miss without falling below the attendance threshold.
• User-Friendly Interface: A clean, responsive design built with Tailwind CSS for ease of use.
• Fast and Scalable: Powered by Next.js for optimal performance and scalability.

Getting Started

To get started with Bunk-Mate, follow these steps:

Prerequisites

Ensure you have the following installed on your system:

Node.js (version 14 or higher)
npm or yarn

Installation

Clone the repository:

git clone https://github.com/Bunk-Mate/Website.git
cd Website/bunk-mater

Install the dependencies:

npm install
# or
yarn install

Run locally

To run the application locally:

npm run dev
# or
yarn dev

This will start the development server, and you can view the application by navigating to http://localhost:3000. Building for Production

To build the project for production:

npm run build
# or
yarn build

Contributing

Contributions are welcome! Feel free to open issues or submit pull requests to improve Bunk-Mate.

License

This project is licensed under the MIT License.