Skip to content
This repository has been archived by the owner on Oct 15, 2023. It is now read-only.

Latest commit

 

History

History
159 lines (126 loc) · 7.2 KB

README.en.md

File metadata and controls

159 lines (126 loc) · 7.2 KB
Raw

Logo

Papillon — Votre vie scolaire

Your timetable, homeworks, grades, news and more in a fresh new UI for any French school service.

Explore the docs »

Read this in other languages: Français, English

Table Of Contents

About The Project

  • Features of Pronote
    • 📆 Timetable
      • Intuitive time management
      • Addition to the calendar
      • Customised courses
      • Notifications
    • 📑 Homeworks
      • Intuitive management of your work schedule
    • 🎓 Grades and skills
      • Overall and class averages
      • Automatic resetting of scores out of 20
      • Intuitive grid display
    • 📂 Course content and files
    • 📰 News
    • 🚪 Absences, lateness and sanctions
  • An incredible interface
    • 🎨 Designed with care and precision
    • ✋ Ready for one-handed use
      • Use of intuitive gestures
    • ✨ Continuously improves with regular updates
    • 📱 Native look for iOS and Android
  • Extensions and customisation
    • 🕺 Customisable font and interface colour
    • 🤯 Extends the functionality of the app

Screenshots

iPhone XR (iOS 16.3.1) (version 5.7.0 - light mode)

Home Timetable Homework Grades Settings
Home image image image image

Built With

Vue.js Ionic CSS3 JavaScript TypeScript

Getting Started

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

Prerequisites

First, grab a copy of this repo and install the needed dependencies to run Papillon locally.

npm i

Installation

PS: In an older version of this file, you had to install the @ionic/cli package. This package is no longer needed, and if you installed it only for Papillon, you can remove it with npm uninstall -g @ionic/cli. We removed it to fix a bug with "Waiting for connectivity with vue-cli-service" message which was CPU intensive. To run papillon, simply run

npm run serve

To build papillon, you need Android Studio or Xcode* installed. Android SDK or Xcode command line tools needs to be configured. All the prerequisites for building are available on https://capacitorjs.com/docs/getting-started/environment-setup

npm run build
npx cap sync
# then build using Android Studio or Xcode

Usage

Papillon is useful to any student using Pronote or EcoleDirecte. If their official app is not enough for you, we're here to improve your digital school experience !

Roadmap

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

Contributing

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

  • If you have suggestions for adding or removing projects, feel free to open an issue to discuss it, or directly create a pull request after you edit the README.md file with necessary changes.
  • Please make sure you check your spelling and grammar.
  • Create individual PR for each suggestion.
  • Please also read through the Code Of Conduct before posting your first idea as well.

Creating A Pull Request

  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

License

Distributed under the GPL-3.0 License. See LICENSE for more information.

Authors

  • Vince Linise - French student in high school - Vince Linise - Creator of Papillon
  • Lucas - French student in high school - Lucas - Active developer
  • Lucas - French student in middle school - Lucas - Server management
  • Nicolas - French student in BTS SIO - Nicolas - Active developer
  • Astrow - French student in high school - Astrow - Developer and tester

Acknowledgements