Skip to content

Latest commit

 

History

History
133 lines (99 loc) · 4.87 KB

Readme.md

File metadata and controls

133 lines (99 loc) · 4.87 KB
Raw

Timetable Generator

This tool is designed to make it easier for students to view and manage their class schedules by extracting data from an Excel sheet and displaying it in a user-friendly manner. With this project, students can quickly see their timetables and save their classes for easy access.

GitHub Repo stars GitHub issues GitHub forks GitHub pull requests GitHub repo size GitHub last commit GitHub License

Collaborators

utkarsh-1905
Utkarsh Tripathi 		nimishmedatwal
Nimish Medatwal 		dgbkn
Dev Goyal 		michaelmuthomi
Michael 		MankiratSingh1315
Mankirat Singh

Table of Contents

  1. How to Use
  2. Features
  3. Getting Started
  4. Usage
  5. Contribution
  6. License

How to use

  1. Go to this link.
  2. Select your branch category and section.
  3. Click on the Get Schedule button.
  4. Alternatively, you can save that data and see the timetable next time without selecting the branch and section again.

Features

  • Import class data from an Excel sheet.
  • Display the class schedule in a clear and organized format.
  • Save and load class schedules for easy access.
  • Intuitive and user-friendly interface.

Getting Started

Prerequisites

Before you start, make sure you have the following prerequisites installed on your system:

  • Go programming language (at least Go 1.14)
  • Git

Installation

  1. Clone the repository: git clone https://github.com/utkarsh-1905/time-table
  2. Build the project: go build
  3. Run the project: go run main.go

Contribution

We welcome contributions from the community to enhance and improve the Timetable Generator project. If you want to contribute, follow these steps:

  1. Fork the repository.

  2. Create a new branch with a descriptive name for your feature or bug fix.

  3. Make your changes and ensure they follow the project's coding guidelines.

  4. Write tests to cover your changes, if applicable.

  5. Run existing tests and make sure everything passes.

  6. Commit your changes and push the branch to your fork.

  7. Open a pull request against the main repository's main branch.

Our team will review your contribution, and once it meets our criteria, we will merge it into the project.

Coding Guidelines

  • Follow the Go language conventions and idioms.
  • Use meaningful names for variables, functions, and types.
  • Write clear and concise comments to explain complex logic.
  • Keep the code modular and well-organized.

Bug Reports and Feature Requests

If you encounter any bugs or have ideas for new features, please open an issue in the project's issue tracker. Be sure to provide sufficient details to reproduce the problem or understand the proposed feature.

License

This project is licensed under the GNU General Public License - see the LICENSE file for details.

Note: Post any discrepency about the timetable here.