Skip to content

yafyx/ugpulse

Repository files navigation

UG Pulse

Overview

UG Pulse is a web application designed to help manage university-related information, including student data, class schedules, and academic timelines. Built with Next.js and NextUI, it provides a modern, responsive interface.

Features

  • Timeline View: Track important academic events and deadlines
  • Student Management: View and manage student information, including class assignments
  • Schedule Management: Access and organize class schedules
  • Responsive Design: Works on desktop and mobile devices
  • Dark/Light Mode: Choose your preferred theme

Tech Stack

Getting Started

Prerequisites

  • Node.js 18.x or later
  • npm or bun package manager

Installation

  1. Clone the repository

    git clone https://github.com/yourusername/ugcnn.git
    cd ugcnn
  2. Install dependencies

    npm install
    # or
    bun install
  3. Run the development server

    npm run dev
    # or
    bun dev
  4. Open http://localhost:3000 in your browser to see the application

Building for Production

npm run build
# or
bun run build

Project Structure

ugcnn/
├── app/                # Next.js app directory
│   ├── page.tsx        # Main page component
│   ├── layout.tsx      # Root layout component
│   └── timeline/       # Timeline page
├── components/         # Reusable UI components
├── config/             # Configuration files
├── public/             # Static assets
└── styles/             # Global styles

Contributing

Contributions are welcome! Please feel free to submit a Pull Request.

License

This project is licensed under the MIT License - see the LICENSE file for details.

Acknowledgments