czerwoniakplus/api

🌊 A fresh look on original CzerwoniakPlus's API, using TypeScript and ExpressJS

CzerwoniakPlus

Newest and most important news, timetables, and more!
Everything for Stefan Rowecki "Grot" School Complex No. 1 in Zambrów.

Open web app · 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

CzerwoniakPlus is a mobile app built by students, for students. It is your source of newest and most important news, timetables and much more. All of that - right at your fingertips.

(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/CzerwoniakPlus.git

2. Install required packages

   yarn install

(back to top)

Roadmap

• Important announcement card
• Lucky number
• Vacation counter
• Current lesson/break timer
• News screen
  • News from school website
• Timetables
• School Year Calendar
• School bell times list
• Public transport screen
  • Integration with mZambrowiak API
  • Arrivals and departures near the school
• Notifications
• Settings
  • Home screen autorefresh
  • Dark mode
  • Notification type selection

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.txt for more information.

(back to top)

Contact

Mateusz Tatko - @mtatko - [email protected]

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

(back to top)

api's Issues

Automatic timetable URL obtaining

As noticed, the timetable URL changes with each timetable change. Due to that, we have to find a way to automatically obtain it.

Key-value object pairs for timetables based on OCR

Azure-based OCR detection of classes in automatically obtained PDFs from the school's website. Data received from timetable scripts will be returned via an endpoint.