TimetableExtractor

📅 A simple tool for sorting the PDFs into classes and storing in base64, using Azure OCR

Report a bug · Request a feature

Table of Contents

1. About the project
   • Built with
2. Getting started
   • Prerequisites
   • Installation
3. Roadmap
4. Contributing
5. License
6. Contact

About The Project

TimetableExtractor is a really simple tool for automatical obtaining, sorting the timetable PDFs by classes using Azure OCR, storing them in base64 and sending to CzerwoniakPlus API.

(back to top)

Built with

• 
• 

(back to top)

Getting Started

To get a local copy up and running follow these simple steps.

Prerequisites

Make sure to use Node.js version of at least v16.15.0 and install newest versions of:

• npm

  npm install npm@latest -g

• yarn

  npm install yarn@latest -g

Installation

1. Clone the repo

   git clone https://github.com/CzerwoniakPlus/TimetableExtractor.git

2. Install required packages

   yarn install

(back to top)

Roadmap

• Automatic timetable URL extraction
• Dividing PDFs into separate buffers
• Reading class name using Azure OCR
• Sorting by class name
• Sending obtained data to API

See the open issues for a full list of proposed features (and known issues).

(back to top)

Contributing

Contributions are what make the open source community such an amazing place to learn, inspire, and create. Any contributions you make are greatly appreciated.

If you have a suggestion that would make this better, please fork the repo and create a pull request. You can also simply open an issue with the tag "enhancement". Don't forget to give the project a star! Thanks again!

1. Fork the Project
2. Create your Feature Branch (git checkout -b feature/AmazingFeature)
3. Commit your Changes (git commit -m 'Add some AmazingFeature')
4. Push to the Branch (git push origin feature/AmazingFeature)
5. Open a Pull Request

(back to top)

License

Distributed under the BSD-3-Clause license. See LICENSE.md for more information.

(back to top)

Contact

Mateusz Tatko - @mtatko - mtatko@mtatko.dev

Project Link: https://github.com/CzerwoniakPlus/TimetableExtractor

(back to top)