https://github.com/shereef/nslunchformatter

This project helps schools convert CSV reports with student names and meals into a consolidated list by meals and classes. The tool can export the consolidated data to PDF format.
https://github.com/shereef/nslunchformatter

app csv formatting github html javascript lunch novascotia ns nslunch pages pdf school sunnyside web

Last synced: 3 months ago
JSON representation

This project helps schools convert CSV reports with student names and meals into a consolidated list by meals and classes. The tool can export the consolidated data to PDF format.

• Host: GitHub
• URL: https://github.com/shereef/nslunchformatter
• Owner: Shereef
• License: mit
• Created: 2024-11-02T17:22:17.000Z (12 months ago)
• Default Branch: main
• Last Pushed: 2025-02-14T10:03:43.000Z (8 months ago)
• Last Synced: 2025-07-21T13:45:26.051Z (3 months ago)
• Topics: app, csv, formatting, github, html, javascript, lunch, novascotia, ns, nslunch, pages, pdf, school, sunnyside, web
• Language: JavaScript
• Homepage: https://shereef.github.io/NSLunchFormatter/
• Size: 3.75 MB
• Stars: 1
• Watchers: 1
• Forks: 0
• Open Issues: 11
• Metadata Files:
  • Readme: README.md
  • Changelog: CHANGELOG.md
  • Contributing: CONTRIBUTING.md
  • License: LICENSE.txt
  • Code of conduct: CODE_OF_CONDUCT.md
  • Security: SECURITY.md

Awesome Lists containing this project

README

          
# Nova Scotia Lunch Formatter

[![CI/CD](https://github.com/Shereef/NSLunchFormatter/actions/workflows/main.yml/badge.svg)](https://github.com/Shereef/NSLunchFormatter/actions/workflows/main.yml)

[![Known Vulnerabilities](https://snyk.io/test/github/Shereef/NSLunchFormatter/badge.svg)](https://snyk.io/test/github/Shereef/NSLunchFormatter)

[![Quality Gate Status](https://sonarcloud.io/api/project_badges/measure?project=Shereef_NSLunchFormatter&metric=alert_status)](https://sonarcloud.io/summary/new_code?id=Shereef_NSLunchFormatter)

[![License: MIT](https://img.shields.io/badge/License-MIT-yellow.svg)](https://opensource.org/licenses/MIT)

[![Code Coverage](https://img.shields.io/codecov/c/github/Shereef/NSLunchFormatter)](https://codecov.io/gh/Shereef/NSLunchFormatter)

[![Code Quality](https://img.shields.io/codeclimate/maintainability/Shereef/NSLunchFormatter)](https://codeclimate.com/github/Shereef/NSLunchFormatter)

[![Contributors](https://img.shields.io/github/contributors/Shereef/NSLunchFormatter)](https://github.com/Shereef/NSLunchFormatter/graphs/contributors)

[![Last Commit](https://img.shields.io/github/last-commit/Shereef/NSLunchFormatter)](https://github.com/Shereef/NSLunchFormatter/commits/main)

This project helps schools convert CSV reports with student names and meals into

a consolidated list by meals and classes. The tool can export the consolidated

data to PDF format.

**Disclaimer: This project is not associated with NSLunch.ca.**



## Features

-   Convert CSV reports to a consolidated list by meals and classes.

-   Export the consolidated data to PDF format.

-   User-friendly interface with advanced options for customization.

-   Supports sorting by home room locations.

-   Provides detailed meal counts per class and location.

-   Generates color-coded PDF reports for easy visualization.

-   Ensures data privacy by processing files locally on the user's computer.

## Getting Started

### Prerequisites

-   A modern web browser (Chrome, Firefox, Edge, etc.)

-   Internet connection to load external libraries (XLSX and jsPDF)

### Installation

No installation is required. Simply open the web page in your browser.

### Usage

1. **Upload CSV File**: Click the "Choose File" button to upload your CSV file containing student names and meal information.

2. **Process File**: Click the "Process File" button to generate the consolidated report.

3. **Advanced Options**: Use the "Hide Advanced Options" checkbox to toggle advanced settings for customization.

### Purpose

The purpose of the Nova Scotia Lunch Formatter is to provide a user-friendly interface for

uploading CSV files containing student names and meal information, and to

process these files to generate a consolidated report in PDF format. This tool is designed to help schools efficiently manage and report meal distribution.

### Data Safety

This page doesn't upload information anywhere. It is safe to use and protects

the information. The information never leaves your computer. This is open source

and hosted on GitHub Pages publicly and can be verified that it's safe by any

tech-savvy person. However, it doesn't support password-protected files.

### Security Policy

If you discover any security vulnerabilities, please refer to our [Security Policy](SECURITY.md) for instructions on how to report them. This helps ensure that any security issues are addressed promptly and responsibly.

### Issues

If you have issues, you can report them by adding issues to this GitHub repo:

[NSLunchFormatter](https://github.com/Shereef/NSLunchFormatter/issues).

### License

This project is licensed under the MIT License - see the

[LICENSE.txt](LICENSE.txt) file for details.

### Contributing

Contributions are welcome! Please refer to our [Contributing Guidelines](CONTRIBUTING.md) for more information on how to contribute.

### Code of Conduct

Please note that this project is released with a [Contributor Code of Conduct](CODE_OF_CONDUCT.md). By participating in this project you agree to abide by its terms.

### Changelog

All notable changes to this project will be documented in the [Changelog](CHANGELOG.md).

### Release Management

This project uses `standard-version` for versioning and changelog generation. To create a new release, run:

### Contact

For any inquiries, please contact [Shereef Marzouk](https://www.linkedin.com/in/shereef/).