├── .cache └── plugin │ └── git-committers │ └── page-authors.json ├── .gitattributes ├── .github └── workflows │ └── ci.yml ├── .gitignore ├── LICENSE ├── README.md ├── docker ├── Dockerfile ├── README.md ├── docker-compose.yml ├── requirements.txt └── update.sh ├── docs ├── CNAME ├── assets │ ├── beta.png │ ├── design │ │ ├── Charte Graphique - Papillon (sept. 2023).pdf │ │ └── font │ │ │ ├── AWF.svg │ │ │ └── AWT.svg │ ├── logo.svg │ └── tuto │ │ └── buildIOS.mp4 ├── contribute │ ├── beta.md │ ├── final-step.md │ ├── intro.md │ ├── pull-request.md │ └── reporting-issues.md ├── design │ ├── color.md │ ├── communication-kit.md │ ├── font.md │ ├── font_old.md │ ├── intro.md │ └── logotype.md ├── development │ ├── api │ │ ├── ed │ │ │ ├── api.md │ │ │ ├── ed.yml │ │ │ └── papillon.md │ │ ├── papillon.md │ │ ├── pawnote.md │ │ └── ts │ │ │ ├── api.md │ │ │ ├── papillon.md │ │ │ └── turboself.yml │ ├── app │ │ ├── android.md │ │ ├── eas.md │ │ └── ios.md │ ├── ent.md │ ├── intro.md │ └── pronote-api │ │ ├── deployment.md │ │ ├── endpoints.md │ │ ├── index.md │ │ └── login.md ├── documents │ ├── privacy-policy.md │ └── terms-of-service.md ├── events │ └── la-meilleure-icone-papillon.md ├── help │ └── index.md ├── index.md ├── index_old.md └── stylesheets │ └── extra.css ├── mkdocs.yml ├── netlify.toml ├── requirements.txt └── runtime.txt /.cache/plugin/git-committers/page-authors.json: -------------------------------------------------------------------------------- 1 | {"cache_date": "2023-08-18", "page_authors": {}} -------------------------------------------------------------------------------- /.gitattributes: -------------------------------------------------------------------------------- 1 | # Auto detect text files and perform LF normalization 2 | * text=auto 3 | -------------------------------------------------------------------------------- /.github/workflows/ci.yml: -------------------------------------------------------------------------------- 1 | name: Déployement de la documentation sur Github Page 2 | on: 3 | push: 4 | branches: 5 | - master 6 | - main 7 | permissions: 8 | contents: write 9 | jobs: 10 | deploy: 11 | runs-on: ubuntu-latest 12 | steps: 13 | - uses: actions/checkout@v4 14 | - name: Configure Git Credentials 15 | run: | 16 | git config user.name github-actions[bot] 17 | git config user.email 41898282+github-actions[bot]@users.noreply.github.com 18 | - uses: actions/setup-python@v5 19 | with: 20 | python-version: 3.x 21 | - run: echo "cache_id=$(date --utc '+%V')" >> $GITHUB_ENV 22 | - uses: actions/cache@v4 23 | with: 24 | key: mkdocs-material-${{ env.cache_id }} 25 | path: .cache 26 | restore-keys: | 27 | mkdocs-material- 28 | - run: pip install -r requirements.txt 29 | - run: mkdocs gh-deploy --force 30 | -------------------------------------------------------------------------------- /.gitignore: -------------------------------------------------------------------------------- 1 | # site compilé 2 | site/ 3 | .idea 4 | .DS_Store 5 | ./*/.DS_Store 6 | ./*/*/.DS_Store -------------------------------------------------------------------------------- /LICENSE: -------------------------------------------------------------------------------- 1 | GNU GENERAL PUBLIC LICENSE 2 | Version 3, 29 June 2007 3 | 4 | Copyright (C) 2007 Free Software Foundation, Inc. 5 | Everyone is permitted to copy and distribute verbatim copies 6 | of this license document, but changing it is not allowed. 7 | 8 | Preamble 9 | 10 | The GNU General Public License is a free, copyleft license for 11 | software and other kinds of works. 12 | 13 | The licenses for most software and other practical works are designed 14 | to take away your freedom to share and change the works. By contrast, 15 | the GNU General Public License is intended to guarantee your freedom to 16 | share and change all versions of a program--to make sure it remains free 17 | software for all its users. We, the Free Software Foundation, use the 18 | GNU General Public License for most of our software; it applies also to 19 | any other work released this way by its authors. You can apply it to 20 | your programs, too. 21 | 22 | When we speak of free software, we are referring to freedom, not 23 | price. Our General Public Licenses are designed to make sure that you 24 | have the freedom to distribute copies of free software (and charge for 25 | them if you wish), that you receive source code or can get it if you 26 | want it, that you can change the software or use pieces of it in new 27 | free programs, and that you know you can do these things. 28 | 29 | To protect your rights, we need to prevent others from denying you 30 | these rights or asking you to surrender the rights. Therefore, you have 31 | certain responsibilities if you distribute copies of the software, or if 32 | you modify it: responsibilities to respect the freedom of others. 33 | 34 | For example, if you distribute copies of such a program, whether 35 | gratis or for a fee, you must pass on to the recipients the same 36 | freedoms that you received. You must make sure that they, too, receive 37 | or can get the source code. And you must show them these terms so they 38 | know their rights. 39 | 40 | Developers that use the GNU GPL protect your rights with two steps: 41 | (1) assert copyright on the software, and (2) offer you this License 42 | giving you legal permission to copy, distribute and/or modify it. 43 | 44 | For the developers' and authors' protection, the GPL clearly explains 45 | that there is no warranty for this free software. For both users' and 46 | authors' sake, the GPL requires that modified versions be marked as 47 | changed, so that their problems will not be attributed erroneously to 48 | authors of previous versions. 49 | 50 | Some devices are designed to deny users access to install or run 51 | modified versions of the software inside them, although the manufacturer 52 | can do so. This is fundamentally incompatible with the aim of 53 | protecting users' freedom to change the software. The systematic 54 | pattern of such abuse occurs in the area of products for individuals to 55 | use, which is precisely where it is most unacceptable. Therefore, we 56 | have designed this version of the GPL to prohibit the practice for those 57 | products. If such problems arise substantially in other domains, we 58 | stand ready to extend this provision to those domains in future versions 59 | of the GPL, as needed to protect the freedom of users. 60 | 61 | Finally, every program is threatened constantly by software patents. 62 | States should not allow patents to restrict development and use of 63 | software on general-purpose computers, but in those that do, we wish to 64 | avoid the special danger that patents applied to a free program could 65 | make it effectively proprietary. To prevent this, the GPL assures that 66 | patents cannot be used to render the program non-free. 67 | 68 | The precise terms and conditions for copying, distribution and 69 | modification follow. 70 | 71 | TERMS AND CONDITIONS 72 | 73 | 0. Definitions. 74 | 75 | "This License" refers to version 3 of the GNU General Public License. 76 | 77 | "Copyright" also means copyright-like laws that apply to other kinds of 78 | works, such as semiconductor masks. 79 | 80 | "The Program" refers to any copyrightable work licensed under this 81 | License. Each licensee is addressed as "you". "Licensees" and 82 | "recipients" may be individuals or organizations. 83 | 84 | To "modify" a work means to copy from or adapt all or part of the work 85 | in a fashion requiring copyright permission, other than the making of an 86 | exact copy. The resulting work is called a "modified version" of the 87 | earlier work or a work "based on" the earlier work. 88 | 89 | A "covered work" means either the unmodified Program or a work based 90 | on the Program. 91 | 92 | To "propagate" a work means to do anything with it that, without 93 | permission, would make you directly or secondarily liable for 94 | infringement under applicable copyright law, except executing it on a 95 | computer or modifying a private copy. Propagation includes copying, 96 | distribution (with or without modification), making available to the 97 | public, and in some countries other activities as well. 98 | 99 | To "convey" a work means any kind of propagation that enables other 100 | parties to make or receive copies. Mere interaction with a user through 101 | a computer network, with no transfer of a copy, is not conveying. 102 | 103 | An interactive user interface displays "Appropriate Legal Notices" 104 | to the extent that it includes a convenient and prominently visible 105 | feature that (1) displays an appropriate copyright notice, and (2) 106 | tells the user that there is no warranty for the work (except to the 107 | extent that warranties are provided), that licensees may convey the 108 | work under this License, and how to view a copy of this License. If 109 | the interface presents a list of user commands or options, such as a 110 | menu, a prominent item in the list meets this criterion. 111 | 112 | 1. Source Code. 113 | 114 | The "source code" for a work means the preferred form of the work 115 | for making modifications to it. "Object code" means any non-source 116 | form of a work. 117 | 118 | A "Standard Interface" means an interface that either is an official 119 | standard defined by a recognized standards body, or, in the case of 120 | interfaces specified for a particular programming language, one that 121 | is widely used among developers working in that language. 122 | 123 | The "System Libraries" of an executable work include anything, other 124 | than the work as a whole, that (a) is included in the normal form of 125 | packaging a Major Component, but which is not part of that Major 126 | Component, and (b) serves only to enable use of the work with that 127 | Major Component, or to implement a Standard Interface for which an 128 | implementation is available to the public in source code form. A 129 | "Major Component", in this context, means a major essential component 130 | (kernel, window system, and so on) of the specific operating system 131 | (if any) on which the executable work runs, or a compiler used to 132 | produce the work, or an object code interpreter used to run it. 133 | 134 | The "Corresponding Source" for a work in object code form means all 135 | the source code needed to generate, install, and (for an executable 136 | work) run the object code and to modify the work, including scripts to 137 | control those activities. However, it does not include the work's 138 | System Libraries, or general-purpose tools or generally available free 139 | programs which are used unmodified in performing those activities but 140 | which are not part of the work. For example, Corresponding Source 141 | includes interface definition files associated with source files for 142 | the work, and the source code for shared libraries and dynamically 143 | linked subprograms that the work is specifically designed to require, 144 | such as by intimate data communication or control flow between those 145 | subprograms and other parts of the work. 146 | 147 | The Corresponding Source need not include anything that users 148 | can regenerate automatically from other parts of the Corresponding 149 | Source. 150 | 151 | The Corresponding Source for a work in source code form is that 152 | same work. 153 | 154 | 2. Basic Permissions. 155 | 156 | All rights granted under this License are granted for the term of 157 | copyright on the Program, and are irrevocable provided the stated 158 | conditions are met. This License explicitly affirms your unlimited 159 | permission to run the unmodified Program. The output from running a 160 | covered work is covered by this License only if the output, given its 161 | content, constitutes a covered work. This License acknowledges your 162 | rights of fair use or other equivalent, as provided by copyright law. 163 | 164 | You may make, run and propagate covered works that you do not 165 | convey, without conditions so long as your license otherwise remains 166 | in force. You may convey covered works to others for the sole purpose 167 | of having them make modifications exclusively for you, or provide you 168 | with facilities for running those works, provided that you comply with 169 | the terms of this License in conveying all material for which you do 170 | not control copyright. Those thus making or running the covered works 171 | for you must do so exclusively on your behalf, under your direction 172 | and control, on terms that prohibit them from making any copies of 173 | your copyrighted material outside their relationship with you. 174 | 175 | Conveying under any other circumstances is permitted solely under 176 | the conditions stated below. Sublicensing is not allowed; section 10 177 | makes it unnecessary. 178 | 179 | 3. Protecting Users' Legal Rights From Anti-Circumvention Law. 180 | 181 | No covered work shall be deemed part of an effective technological 182 | measure under any applicable law fulfilling obligations under article 183 | 11 of the WIPO copyright treaty adopted on 20 December 1996, or 184 | similar laws prohibiting or restricting circumvention of such 185 | measures. 186 | 187 | When you convey a covered work, you waive any legal power to forbid 188 | circumvention of technological measures to the extent such circumvention 189 | is effected by exercising rights under this License with respect to 190 | the covered work, and you disclaim any intention to limit operation or 191 | modification of the work as a means of enforcing, against the work's 192 | users, your or third parties' legal rights to forbid circumvention of 193 | technological measures. 194 | 195 | 4. Conveying Verbatim Copies. 196 | 197 | You may convey verbatim copies of the Program's source code as you 198 | receive it, in any medium, provided that you conspicuously and 199 | appropriately publish on each copy an appropriate copyright notice; 200 | keep intact all notices stating that this License and any 201 | non-permissive terms added in accord with section 7 apply to the code; 202 | keep intact all notices of the absence of any warranty; and give all 203 | recipients a copy of this License along with the Program. 204 | 205 | You may charge any price or no price for each copy that you convey, 206 | and you may offer support or warranty protection for a fee. 207 | 208 | 5. Conveying Modified Source Versions. 209 | 210 | You may convey a work based on the Program, or the modifications to 211 | produce it from the Program, in the form of source code under the 212 | terms of section 4, provided that you also meet all of these conditions: 213 | 214 | a) The work must carry prominent notices stating that you modified 215 | it, and giving a relevant date. 216 | 217 | b) The work must carry prominent notices stating that it is 218 | released under this License and any conditions added under section 219 | 7. This requirement modifies the requirement in section 4 to 220 | "keep intact all notices". 221 | 222 | c) You must license the entire work, as a whole, under this 223 | License to anyone who comes into possession of a copy. This 224 | License will therefore apply, along with any applicable section 7 225 | additional terms, to the whole of the work, and all its parts, 226 | regardless of how they are packaged. This License gives no 227 | permission to license the work in any other way, but it does not 228 | invalidate such permission if you have separately received it. 229 | 230 | d) If the work has interactive user interfaces, each must display 231 | Appropriate Legal Notices; however, if the Program has interactive 232 | interfaces that do not display Appropriate Legal Notices, your 233 | work need not make them do so. 234 | 235 | A compilation of a covered work with other separate and independent 236 | works, which are not by their nature extensions of the covered work, 237 | and which are not combined with it such as to form a larger program, 238 | in or on a volume of a storage or distribution medium, is called an 239 | "aggregate" if the compilation and its resulting copyright are not 240 | used to limit the access or legal rights of the compilation's users 241 | beyond what the individual works permit. Inclusion of a covered work 242 | in an aggregate does not cause this License to apply to the other 243 | parts of the aggregate. 244 | 245 | 6. Conveying Non-Source Forms. 246 | 247 | You may convey a covered work in object code form under the terms 248 | of sections 4 and 5, provided that you also convey the 249 | machine-readable Corresponding Source under the terms of this License, 250 | in one of these ways: 251 | 252 | a) Convey the object code in, or embodied in, a physical product 253 | (including a physical distribution medium), accompanied by the 254 | Corresponding Source fixed on a durable physical medium 255 | customarily used for software interchange. 256 | 257 | b) Convey the object code in, or embodied in, a physical product 258 | (including a physical distribution medium), accompanied by a 259 | written offer, valid for at least three years and valid for as 260 | long as you offer spare parts or customer support for that product 261 | model, to give anyone who possesses the object code either (1) a 262 | copy of the Corresponding Source for all the software in the 263 | product that is covered by this License, on a durable physical 264 | medium customarily used for software interchange, for a price no 265 | more than your reasonable cost of physically performing this 266 | conveying of source, or (2) access to copy the 267 | Corresponding Source from a network server at no charge. 268 | 269 | c) Convey individual copies of the object code with a copy of the 270 | written offer to provide the Corresponding Source. This 271 | alternative is allowed only occasionally and noncommercially, and 272 | only if you received the object code with such an offer, in accord 273 | with subsection 6b. 274 | 275 | d) Convey the object code by offering access from a designated 276 | place (gratis or for a charge), and offer equivalent access to the 277 | Corresponding Source in the same way through the same place at no 278 | further charge. You need not require recipients to copy the 279 | Corresponding Source along with the object code. If the place to 280 | copy the object code is a network server, the Corresponding Source 281 | may be on a different server (operated by you or a third party) 282 | that supports equivalent copying facilities, provided you maintain 283 | clear directions next to the object code saying where to find the 284 | Corresponding Source. Regardless of what server hosts the 285 | Corresponding Source, you remain obligated to ensure that it is 286 | available for as long as needed to satisfy these requirements. 287 | 288 | e) Convey the object code using peer-to-peer transmission, provided 289 | you inform other peers where the object code and Corresponding 290 | Source of the work are being offered to the general public at no 291 | charge under subsection 6d. 292 | 293 | A separable portion of the object code, whose source code is excluded 294 | from the Corresponding Source as a System Library, need not be 295 | included in conveying the object code work. 296 | 297 | A "User Product" is either (1) a "consumer product", which means any 298 | tangible personal property which is normally used for personal, family, 299 | or household purposes, or (2) anything designed or sold for incorporation 300 | into a dwelling. In determining whether a product is a consumer product, 301 | doubtful cases shall be resolved in favor of coverage. For a particular 302 | product received by a particular user, "normally used" refers to a 303 | typical or common use of that class of product, regardless of the status 304 | of the particular user or of the way in which the particular user 305 | actually uses, or expects or is expected to use, the product. A product 306 | is a consumer product regardless of whether the product has substantial 307 | commercial, industrial or non-consumer uses, unless such uses represent 308 | the only significant mode of use of the product. 309 | 310 | "Installation Information" for a User Product means any methods, 311 | procedures, authorization keys, or other information required to install 312 | and execute modified versions of a covered work in that User Product from 313 | a modified version of its Corresponding Source. The information must 314 | suffice to ensure that the continued functioning of the modified object 315 | code is in no case prevented or interfered with solely because 316 | modification has been made. 317 | 318 | If you convey an object code work under this section in, or with, or 319 | specifically for use in, a User Product, and the conveying occurs as 320 | part of a transaction in which the right of possession and use of the 321 | User Product is transferred to the recipient in perpetuity or for a 322 | fixed term (regardless of how the transaction is characterized), the 323 | Corresponding Source conveyed under this section must be accompanied 324 | by the Installation Information. But this requirement does not apply 325 | if neither you nor any third party retains the ability to install 326 | modified object code on the User Product (for example, the work has 327 | been installed in ROM). 328 | 329 | The requirement to provide Installation Information does not include a 330 | requirement to continue to provide support service, warranty, or updates 331 | for a work that has been modified or installed by the recipient, or for 332 | the User Product in which it has been modified or installed. Access to a 333 | network may be denied when the modification itself materially and 334 | adversely affects the operation of the network or violates the rules and 335 | protocols for communication across the network. 336 | 337 | Corresponding Source conveyed, and Installation Information provided, 338 | in accord with this section must be in a format that is publicly 339 | documented (and with an implementation available to the public in 340 | source code form), and must require no special password or key for 341 | unpacking, reading or copying. 342 | 343 | 7. Additional Terms. 344 | 345 | "Additional permissions" are terms that supplement the terms of this 346 | License by making exceptions from one or more of its conditions. 347 | Additional permissions that are applicable to the entire Program shall 348 | be treated as though they were included in this License, to the extent 349 | that they are valid under applicable law. If additional permissions 350 | apply only to part of the Program, that part may be used separately 351 | under those permissions, but the entire Program remains governed by 352 | this License without regard to the additional permissions. 353 | 354 | When you convey a copy of a covered work, you may at your option 355 | remove any additional permissions from that copy, or from any part of 356 | it. (Additional permissions may be written to require their own 357 | removal in certain cases when you modify the work.) You may place 358 | additional permissions on material, added by you to a covered work, 359 | for which you have or can give appropriate copyright permission. 360 | 361 | Notwithstanding any other provision of this License, for material you 362 | add to a covered work, you may (if authorized by the copyright holders of 363 | that material) supplement the terms of this License with terms: 364 | 365 | a) Disclaiming warranty or limiting liability differently from the 366 | terms of sections 15 and 16 of this License; or 367 | 368 | b) Requiring preservation of specified reasonable legal notices or 369 | author attributions in that material or in the Appropriate Legal 370 | Notices displayed by works containing it; or 371 | 372 | c) Prohibiting misrepresentation of the origin of that material, or 373 | requiring that modified versions of such material be marked in 374 | reasonable ways as different from the original version; or 375 | 376 | d) Limiting the use for publicity purposes of names of licensors or 377 | authors of the material; or 378 | 379 | e) Declining to grant rights under trademark law for use of some 380 | trade names, trademarks, or service marks; or 381 | 382 | f) Requiring indemnification of licensors and authors of that 383 | material by anyone who conveys the material (or modified versions of 384 | it) with contractual assumptions of liability to the recipient, for 385 | any liability that these contractual assumptions directly impose on 386 | those licensors and authors. 387 | 388 | All other non-permissive additional terms are considered "further 389 | restrictions" within the meaning of section 10. If the Program as you 390 | received it, or any part of it, contains a notice stating that it is 391 | governed by this License along with a term that is a further 392 | restriction, you may remove that term. If a license document contains 393 | a further restriction but permits relicensing or conveying under this 394 | License, you may add to a covered work material governed by the terms 395 | of that license document, provided that the further restriction does 396 | not survive such relicensing or conveying. 397 | 398 | If you add terms to a covered work in accord with this section, you 399 | must place, in the relevant source files, a statement of the 400 | additional terms that apply to those files, or a notice indicating 401 | where to find the applicable terms. 402 | 403 | Additional terms, permissive or non-permissive, may be stated in the 404 | form of a separately written license, or stated as exceptions; 405 | the above requirements apply either way. 406 | 407 | 8. Termination. 408 | 409 | You may not propagate or modify a covered work except as expressly 410 | provided under this License. Any attempt otherwise to propagate or 411 | modify it is void, and will automatically terminate your rights under 412 | this License (including any patent licenses granted under the third 413 | paragraph of section 11). 414 | 415 | However, if you cease all violation of this License, then your 416 | license from a particular copyright holder is reinstated (a) 417 | provisionally, unless and until the copyright holder explicitly and 418 | finally terminates your license, and (b) permanently, if the copyright 419 | holder fails to notify you of the violation by some reasonable means 420 | prior to 60 days after the cessation. 421 | 422 | Moreover, your license from a particular copyright holder is 423 | reinstated permanently if the copyright holder notifies you of the 424 | violation by some reasonable means, this is the first time you have 425 | received notice of violation of this License (for any work) from that 426 | copyright holder, and you cure the violation prior to 30 days after 427 | your receipt of the notice. 428 | 429 | Termination of your rights under this section does not terminate the 430 | licenses of parties who have received copies or rights from you under 431 | this License. If your rights have been terminated and not permanently 432 | reinstated, you do not qualify to receive new licenses for the same 433 | material under section 10. 434 | 435 | 9. Acceptance Not Required for Having Copies. 436 | 437 | You are not required to accept this License in order to receive or 438 | run a copy of the Program. Ancillary propagation of a covered work 439 | occurring solely as a consequence of using peer-to-peer transmission 440 | to receive a copy likewise does not require acceptance. However, 441 | nothing other than this License grants you permission to propagate or 442 | modify any covered work. These actions infringe copyright if you do 443 | not accept this License. Therefore, by modifying or propagating a 444 | covered work, you indicate your acceptance of this License to do so. 445 | 446 | 10. Automatic Licensing of Downstream Recipients. 447 | 448 | Each time you convey a covered work, the recipient automatically 449 | receives a license from the original licensors, to run, modify and 450 | propagate that work, subject to this License. You are not responsible 451 | for enforcing compliance by third parties with this License. 452 | 453 | An "entity transaction" is a transaction transferring control of an 454 | organization, or substantially all assets of one, or subdividing an 455 | organization, or merging organizations. If propagation of a covered 456 | work results from an entity transaction, each party to that 457 | transaction who receives a copy of the work also receives whatever 458 | licenses to the work the party's predecessor in interest had or could 459 | give under the previous paragraph, plus a right to possession of the 460 | Corresponding Source of the work from the predecessor in interest, if 461 | the predecessor has it or can get it with reasonable efforts. 462 | 463 | You may not impose any further restrictions on the exercise of the 464 | rights granted or affirmed under this License. For example, you may 465 | not impose a license fee, royalty, or other charge for exercise of 466 | rights granted under this License, and you may not initiate litigation 467 | (including a cross-claim or counterclaim in a lawsuit) alleging that 468 | any patent claim is infringed by making, using, selling, offering for 469 | sale, or importing the Program or any portion of it. 470 | 471 | 11. Patents. 472 | 473 | A "contributor" is a copyright holder who authorizes use under this 474 | License of the Program or a work on which the Program is based. The 475 | work thus licensed is called the contributor's "contributor version". 476 | 477 | A contributor's "essential patent claims" are all patent claims 478 | owned or controlled by the contributor, whether already acquired or 479 | hereafter acquired, that would be infringed by some manner, permitted 480 | by this License, of making, using, or selling its contributor version, 481 | but do not include claims that would be infringed only as a 482 | consequence of further modification of the contributor version. For 483 | purposes of this definition, "control" includes the right to grant 484 | patent sublicenses in a manner consistent with the requirements of 485 | this License. 486 | 487 | Each contributor grants you a non-exclusive, worldwide, royalty-free 488 | patent license under the contributor's essential patent claims, to 489 | make, use, sell, offer for sale, import and otherwise run, modify and 490 | propagate the contents of its contributor version. 491 | 492 | In the following three paragraphs, a "patent license" is any express 493 | agreement or commitment, however denominated, not to enforce a patent 494 | (such as an express permission to practice a patent or covenant not to 495 | sue for patent infringement). To "grant" such a patent license to a 496 | party means to make such an agreement or commitment not to enforce a 497 | patent against the party. 498 | 499 | If you convey a covered work, knowingly relying on a patent license, 500 | and the Corresponding Source of the work is not available for anyone 501 | to copy, free of charge and under the terms of this License, through a 502 | publicly available network server or other readily accessible means, 503 | then you must either (1) cause the Corresponding Source to be so 504 | available, or (2) arrange to deprive yourself of the benefit of the 505 | patent license for this particular work, or (3) arrange, in a manner 506 | consistent with the requirements of this License, to extend the patent 507 | license to downstream recipients. "Knowingly relying" means you have 508 | actual knowledge that, but for the patent license, your conveying the 509 | covered work in a country, or your recipient's use of the covered work 510 | in a country, would infringe one or more identifiable patents in that 511 | country that you have reason to believe are valid. 512 | 513 | If, pursuant to or in connection with a single transaction or 514 | arrangement, you convey, or propagate by procuring conveyance of, a 515 | covered work, and grant a patent license to some of the parties 516 | receiving the covered work authorizing them to use, propagate, modify 517 | or convey a specific copy of the covered work, then the patent license 518 | you grant is automatically extended to all recipients of the covered 519 | work and works based on it. 520 | 521 | A patent license is "discriminatory" if it does not include within 522 | the scope of its coverage, prohibits the exercise of, or is 523 | conditioned on the non-exercise of one or more of the rights that are 524 | specifically granted under this License. You may not convey a covered 525 | work if you are a party to an arrangement with a third party that is 526 | in the business of distributing software, under which you make payment 527 | to the third party based on the extent of your activity of conveying 528 | the work, and under which the third party grants, to any of the 529 | parties who would receive the covered work from you, a discriminatory 530 | patent license (a) in connection with copies of the covered work 531 | conveyed by you (or copies made from those copies), or (b) primarily 532 | for and in connection with specific products or compilations that 533 | contain the covered work, unless you entered into that arrangement, 534 | or that patent license was granted, prior to 28 March 2007. 535 | 536 | Nothing in this License shall be construed as excluding or limiting 537 | any implied license or other defenses to infringement that may 538 | otherwise be available to you under applicable patent law. 539 | 540 | 12. No Surrender of Others' Freedom. 541 | 542 | If conditions are imposed on you (whether by court order, agreement or 543 | otherwise) that contradict the conditions of this License, they do not 544 | excuse you from the conditions of this License. If you cannot convey a 545 | covered work so as to satisfy simultaneously your obligations under this 546 | License and any other pertinent obligations, then as a consequence you may 547 | not convey it at all. For example, if you agree to terms that obligate you 548 | to collect a royalty for further conveying from those to whom you convey 549 | the Program, the only way you could satisfy both those terms and this 550 | License would be to refrain entirely from conveying the Program. 551 | 552 | 13. Use with the GNU Affero General Public License. 553 | 554 | Notwithstanding any other provision of this License, you have 555 | permission to link or combine any covered work with a work licensed 556 | under version 3 of the GNU Affero General Public License into a single 557 | combined work, and to convey the resulting work. The terms of this 558 | License will continue to apply to the part which is the covered work, 559 | but the special requirements of the GNU Affero General Public License, 560 | section 13, concerning interaction through a network will apply to the 561 | combination as such. 562 | 563 | 14. Revised Versions of this License. 564 | 565 | The Free Software Foundation may publish revised and/or new versions of 566 | the GNU General Public License from time to time. Such new versions will 567 | be similar in spirit to the present version, but may differ in detail to 568 | address new problems or concerns. 569 | 570 | Each version is given a distinguishing version number. If the 571 | Program specifies that a certain numbered version of the GNU General 572 | Public License "or any later version" applies to it, you have the 573 | option of following the terms and conditions either of that numbered 574 | version or of any later version published by the Free Software 575 | Foundation. If the Program does not specify a version number of the 576 | GNU General Public License, you may choose any version ever published 577 | by the Free Software Foundation. 578 | 579 | If the Program specifies that a proxy can decide which future 580 | versions of the GNU General Public License can be used, that proxy's 581 | public statement of acceptance of a version permanently authorizes you 582 | to choose that version for the Program. 583 | 584 | Later license versions may give you additional or different 585 | permissions. However, no additional obligations are imposed on any 586 | author or copyright holder as a result of your choosing to follow a 587 | later version. 588 | 589 | 15. Disclaimer of Warranty. 590 | 591 | THERE IS NO WARRANTY FOR THE PROGRAM, TO THE EXTENT PERMITTED BY 592 | APPLICABLE LAW. EXCEPT WHEN OTHERWISE STATED IN WRITING THE COPYRIGHT 593 | HOLDERS AND/OR OTHER PARTIES PROVIDE THE PROGRAM "AS IS" WITHOUT WARRANTY 594 | OF ANY KIND, EITHER EXPRESSED OR IMPLIED, INCLUDING, BUT NOT LIMITED TO, 595 | THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR 596 | PURPOSE. THE ENTIRE RISK AS TO THE QUALITY AND PERFORMANCE OF THE PROGRAM 597 | IS WITH YOU. SHOULD THE PROGRAM PROVE DEFECTIVE, YOU ASSUME THE COST OF 598 | ALL NECESSARY SERVICING, REPAIR OR CORRECTION. 599 | 600 | 16. Limitation of Liability. 601 | 602 | IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING 603 | WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MODIFIES AND/OR CONVEYS 604 | THE PROGRAM AS PERMITTED ABOVE, BE LIABLE TO YOU FOR DAMAGES, INCLUDING ANY 605 | GENERAL, SPECIAL, INCIDENTAL OR CONSEQUENTIAL DAMAGES ARISING OUT OF THE 606 | USE OR INABILITY TO USE THE PROGRAM (INCLUDING BUT NOT LIMITED TO LOSS OF 607 | DATA OR DATA BEING RENDERED INACCURATE OR LOSSES SUSTAINED BY YOU OR THIRD 608 | PARTIES OR A FAILURE OF THE PROGRAM TO OPERATE WITH ANY OTHER PROGRAMS), 609 | EVEN IF SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE POSSIBILITY OF 610 | SUCH DAMAGES. 611 | 612 | 17. Interpretation of Sections 15 and 16. 613 | 614 | If the disclaimer of warranty and limitation of liability provided 615 | above cannot be given local legal effect according to their terms, 616 | reviewing courts shall apply local law that most closely approximates 617 | an absolute waiver of all civil liability in connection with the 618 | Program, unless a warranty or assumption of liability accompanies a 619 | copy of the Program in return for a fee. 620 | 621 | END OF TERMS AND CONDITIONS 622 | 623 | How to Apply These Terms to Your New Programs 624 | 625 | If you develop a new program, and you want it to be of the greatest 626 | possible use to the public, the best way to achieve this is to make it 627 | free software which everyone can redistribute and change under these terms. 628 | 629 | To do so, attach the following notices to the program. It is safest 630 | to attach them to the start of each source file to most effectively 631 | state the exclusion of warranty; and each file should have at least 632 | the "copyright" line and a pointer to where the full notice is found. 633 | 634 | 635 | Copyright (C) 636 | 637 | This program is free software: you can redistribute it and/or modify 638 | it under the terms of the GNU General Public License as published by 639 | the Free Software Foundation, either version 3 of the License, or 640 | (at your option) any later version. 641 | 642 | This program is distributed in the hope that it will be useful, 643 | but WITHOUT ANY WARRANTY; without even the implied warranty of 644 | MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the 645 | GNU General Public License for more details. 646 | 647 | You should have received a copy of the GNU General Public License 648 | along with this program. If not, see . 649 | 650 | Also add information on how to contact you by electronic and paper mail. 651 | 652 | If the program does terminal interaction, make it output a short 653 | notice like this when it starts in an interactive mode: 654 | 655 | Copyright (C) 656 | This program comes with ABSOLUTELY NO WARRANTY; for details type `show w'. 657 | This is free software, and you are welcome to redistribute it 658 | under certain conditions; type `show c' for details. 659 | 660 | The hypothetical commands `show w' and `show c' should show the appropriate 661 | parts of the General Public License. Of course, your program's commands 662 | might be different; for a GUI interface, you would use an "about box". 663 | 664 | You should also get your employer (if you work as a programmer) or school, 665 | if any, to sign a "copyright disclaimer" for the program, if necessary. 666 | For more information on this, and how to apply and follow the GNU GPL, see 667 | . 668 | 669 | The GNU General Public License does not permit incorporating your program 670 | into proprietary programs. If your program is a subroutine library, you 671 | may consider it more useful to permit linking proprietary applications with 672 | the library. If this is what you want to do, use the GNU Lesser General 673 | Public License instead of this License. But first, please read 674 | . 675 | -------------------------------------------------------------------------------- /README.md: -------------------------------------------------------------------------------- 1 | # Documentation de Papillon 2 | Vous pouvez contribuer à la documentation de Papillon via ce dépôt GitHub. 3 | 4 | ## Ajouter des pages 5 | Le contenu du site est écrit en [**Markdown**](https://docs.github.com/fr/get-started/writing-on-github/getting-started-with-writing-and-formatting-on-github/basic-writing-and-formatting-syntax) et se trouve dans `/docs`. 6 | 7 | Le site web est ensuite généré par [MkDocs](https://www.mkdocs.org/) avec le modèle [Material for MkDocs](https://squidfunk.github.io/mkdocs-material/reference/). 8 | 9 | Vous pouvez vous aider de la [référence de Material for MkDocs](https://squidfunk.github.io/mkdocs-material/reference/). 10 | 11 | Forkez ce dépôt, faites vos propositions et envoyez une **pull request**. On l'acceptera au plus vite. 12 | 13 | ## Compiler localement 14 | Pour tester vos changements sur votre ordinateur avant l'envoi: 15 | 16 | 1. Installez [Python](https://python.org) 17 | - Sur Windows, cochez l'option pour *ajouter Python au PATH* lors de l'installation 18 | 2. Clonez le référentiel et ouvrez un terminal dans le dossier du clone 19 | 3. Installez les outils nécessaires avec: 20 | ```shell 21 | pip3 install -r requirements.txt 22 | ``` 23 | 4. Démarrez un serveur compilant automatiquement les modifications : 24 | ```shell 25 | mkdocs serve 26 | ``` 27 | -------------------------------------------------------------------------------- /docker/Dockerfile: -------------------------------------------------------------------------------- 1 | FROM python:3.9-slim 2 | WORKDIR /app 3 | RUN apt-get update && apt-get install -y git cron 4 | RUN git clone https://github.com/PapillonApp/docs.git . 5 | RUN pip3 install -r requirements.txt 6 | EXPOSE 8000/tcp 7 | COPY update.sh /app/update.sh 8 | RUN chmod +x /app/update.sh 9 | RUN echo "0 * * * * /app/update.sh" > /etc/cron.d/update-cron 10 | RUN crontab /etc/cron.d/update-cron 11 | CMD ["mkdocs", "serve", "--dev-addr=0.0.0.0:8000"] 12 | -------------------------------------------------------------------------------- /docker/README.md: -------------------------------------------------------------------------------- 1 | # Image docker pour la documentation de Papillon 2 | 3 | ## Déploiement classique avec le Dockerfile 4 | ```bash 5 | docker build -t papillondoc . 6 | docker run -d -p 8000:8000 --name PapillonDoc papillondoc 7 | ``` 8 | 9 | ## Déploiement au sein d'un cluster swarm avec l'image créée précédemment' 10 | ```bash 11 | docker stack deploy -c docker-compose.yml PapillonDoc 12 | ``` 13 | -------------------------------------------------------------------------------- /docker/docker-compose.yml: -------------------------------------------------------------------------------- 1 | version: '3.8' 2 | 3 | services: 4 | mkdocs: 5 | image: papillondoc 6 | deploy: 7 | mode: replicated 8 | replicas: 2 9 | placement: 10 | constraints: 11 | - node.role == worker 12 | ports: 13 | - "8000:8000" 14 | -------------------------------------------------------------------------------- /docker/requirements.txt: -------------------------------------------------------------------------------- 1 | mkdocs-material>=9.2.0b2 2 | mkdocs-git-committers-plugin-2>=1.1.2 3 | mkdocs-git-revision-date-localized-plugin>=1.2.0 4 | mkdocs-render-swagger-plugin>=0.1.1 5 | -------------------------------------------------------------------------------- /docker/update.sh: -------------------------------------------------------------------------------- 1 | #!/bin/bash 2 | cd /app 3 | git pull origin master 4 | -------------------------------------------------------------------------------- /docs/CNAME: -------------------------------------------------------------------------------- 1 | docs.getpapillon.xyz 2 | -------------------------------------------------------------------------------- /docs/assets/beta.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/PapillonApp/old-docs/b4fcfd2318fe45550eabc74bf623be0e40e9e565/docs/assets/beta.png -------------------------------------------------------------------------------- /docs/assets/design/Charte Graphique - Papillon (sept. 2023).pdf: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/PapillonApp/old-docs/b4fcfd2318fe45550eabc74bf623be0e40e9e565/docs/assets/design/Charte Graphique - Papillon (sept. 2023).pdf -------------------------------------------------------------------------------- /docs/assets/logo.svg: -------------------------------------------------------------------------------- 1 | 2 | 3 | 4 | -------------------------------------------------------------------------------- /docs/assets/tuto/buildIOS.mp4: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/PapillonApp/old-docs/b4fcfd2318fe45550eabc74bf623be0e40e9e565/docs/assets/tuto/buildIOS.mp4 -------------------------------------------------------------------------------- /docs/contribute/beta.md: -------------------------------------------------------------------------------- 1 | Afin d'accéder aux fonctionnalités en développement et d'aider à rendre Papillon plus stable et accessible à tous, vous pouvez rejoindre le programme bêta. 2 | 3 | ## Qu'est-ce qu'une bêta ? 4 | Une version bêta est une version en cours de développement et de test de l'application, prévue pour être corrigée et publiée à tous à l'avenir. 5 | 6 | ### Comment ça fonctionne sur Papillon 7 | Les versions de Papillon ont généralement 2 à 3 étapes de déploiement (Bêta-testing, correctifs, et déploiement). 8 | Il faut savoir que chaque version peut prendre quelques jours pour parvenir à votre smartphone. 9 | 10 | !!! note 11 | 12 | Les numéros de version indiquent les changements apportés. 13 | 14 | - Les versions 6.X apportent des fonctionnalités majeures et d'importants correctifs. 15 | - Les versions 6.X.X apportent des fonctionnalités mineures et des correctifs habituels. 16 | - Les versions 6.X.X.X apportent des correctifs rapides pour des problèmes particuliers. 17 | 18 | ## Avant de commencer 19 | Avant de commencer, n'oubliez pas que : 20 | 21 | - 💀 Les versions bêta sont **instables**, elles peuvent causer des crashs et d'autres dysfonctionnements. 22 | - 🤬 Nous ne pouvons pas réparer un bug en 2 jours, soyez patients... 23 | - 🔍 Des fonctionnalités peuvent ne pas fonctionner correctement ou plus du tout. 24 | - 🔥 Vous pouvez perdre des paramètres appliqués à l'application. 25 | 26 | ## Obtenir la bêta 27 | 28 | === "iOS (TestFlight)" 29 | ### ⚠ Attention ! 30 | L'application **TestFlight** d'Apple et un compte iCloud valide sont nécessaires pour télécharger des applications en bêta ! 31 | 32 | Les instructions d'installation sont précisées sur le lien d'inscription. 33 | 34 | [S'inscrire à la bêta TestFlight](https://beta.getpapillon.xyz){ .md-button .md-button--primary } 35 | 36 | === "Android (Google Play)" 37 | ### ⚠ Attention ! 38 | Un compte Google Play valide est nécessaire pour rejoindre la bêta. Autrement, vous pouvez télécharger l'APK de l'application sur GitHub. 39 | 40 | [Rejoindre la bêta Google Play](https://play.google.com/apps/testing/xyz.getpapillon.app){ .md-button .md-button--primary } 41 | [Obtenir l'APK](https://github.com/PapillonApp/Papillon/releases){ .md-button } 42 | -------------------------------------------------------------------------------- /docs/contribute/final-step.md: -------------------------------------------------------------------------------- 1 | # Parution dans l'application finale (stable) 2 | 3 | ## Les branches 4 | 5 | Papillon a plusieurs branches sur son repo : 6 | 7 | - `stable` est la branche à laquelle le public a accès via les stores. 8 | - `beta` est la branche de test où les nouvelles fonctionnalités sont testées avant d'être publiées dans la branche stable. 9 | - `development` est la branche de développement où les nouvelles fonctionnalités sont ajoutées et les bugs sont corrigés. 10 | 11 | ## Processus de publication 12 | 13 | Lorsqu'une nouvelle fonctionnalité est prête à être publiée, elle est fusionnée dans la branche de développement. 14 | 15 | Les nouvelles publications sont gérées par l'équipe de coordination. Lorsqu'une nouvelle publication est prête, elle est soumise à une demande de fusion dans la branche bêta. GitHub Actions est utilisé pour automatiser le processus de publication ainsi que pour la publier sur les stores de test. Une fois que la publication est testée et prête à être publiée, elle est fusionnée dans la branche stable. GitHub Actions est utilisé pour automatiser le processus de publication ainsi que pour la publier sur les stores. 16 | 17 |
18 | 19 | ```mermaid 20 | graph TD 21 | A(Développement) -->|Test par les devs| B(Bêta) 22 | B -->|Publié sur les stores de test| ST(Testflight, Google Play Beta) 23 | ST -->|Test par le public| C(Stable) 24 | C -->|Publié sur les stores| S(App Store, Google Play) 25 | S -->|Téléchargé par le public| U(Utilisateurs finaux) 26 | ``` 27 |
28 | -------------------------------------------------------------------------------- /docs/contribute/intro.md: -------------------------------------------------------------------------------- 1 | # Contribuer 2 | 3 | Merci de votre intérêt pour contribuer à Papillon. Il y a plusieurs façons de contribuer, que vous soyez un développeur expérimenté ou que vous n'ayez jamais contribué à un projet open-source auparavant. 4 | 5 | ## Comment contribuer 6 | 7 | Il existe plusieurs façons de contribuer à Papillon : 8 | 9 | - **Soumettre des pull requests** : Si vous avez des idées pour améliorer l'application ou si vous souhaitez corriger des bugs, vous pouvez soumettre des pull requests sur GitHub. Consultez notre [guide de pull requests](pull-request.md) pour obtenir des instructions détaillées sur la manière de soumettre des pull requests. 10 | 11 | - **Signaler des problèmes** : Si vous rencontrez des problèmes ou des bugs dans l'application, vous pouvez les signaler en créant une issue sur GitHub. Consultez notre [guide de signalement des problèmes](reporting-issues.md) pour obtenir des instructions détaillées sur la manière de signaler des problèmes. 12 | -------------------------------------------------------------------------------- /docs/contribute/pull-request.md: -------------------------------------------------------------------------------- 1 | # Pull Request 2 | 3 | Les pull requests sont un moyen de contribuer à un projet en apportant des modifications à un dépôt. Elles sont souvent utilisées pour discuter des modifications que vous souhaitez apporter avant de les fusionner dans le dépôt. 4 | 5 | ## Chez Papillon 6 | 7 | Chez Papillon, nous avons une politique de pull request pour les branches de développement. Cela signifie que chaque modification doit être soumise à une pull request avant d'être fusionnée dans la branche de développement. 8 | 9 | ## Processus de pull request 10 | 11 | 1. Choisir la catégorie de la modification 12 | 2. Soumettre votre code pour évaluation 13 | 3. Les responsables de la catégorie et la personne de la coordination évalueront votre code 14 | 4. Si votre code est valide, il sera fusionné dans la branche de développement 15 | 16 | ```mermaid 17 | 18 | stateDiagram-v2 19 | CE : Code évalué 20 | RP : Responsable de la catégorie 21 | PCV : PC valide ? 22 | RPV : RP valide ? 23 | PC : Personne de la coordination 24 | BD : Branche de développement 25 | 26 | state PCV <> 27 | state RPV <> 28 | state join_state <> 29 | 30 | [*] --> CE 31 | 32 | CE --> RP 33 | RP --> RPV 34 | RPV --> join_state : Oui 35 | RPV --> CE : Suggère des modifications 36 | 37 | CE --> PC 38 | PC --> PCV 39 | PCV --> join_state : Oui 40 | PCV --> CE : Suggère des modifications 41 | 42 | join_state --> BD : Fusion de la demande 43 | ``` 44 | 45 | !!! info "Comment nommer les pull requests" 46 | Nous recommandons au développeur d'utiliser les noms de commit conventionnel. Plus d'informations à [cette adresse](https://www.conventionalcommits.org/fr/v1.0.0/). 47 | 48 | !!! info "" 49 | Les pull requests peuvent être refusées si elles ne respectent pas les normes de codage ou si elles ne sont pas valides. 50 | 51 | !!! note "" 52 | Il est inutile de soumettre une pull request si votre code n'est pas prêt à être fusionné. Assurez-vous que votre code est prêt à être fusionné avant de soumettre une pull request. 53 | 54 | !!! failure "Harcèlement interdit" 55 | Il est interdit d'harceler les responsables de la catégorie ou la personne de la coordination pour qu'ils fusionnent votre pull request. Ils prendront le temps d'évaluer votre code et de vous donner des retours dès qu'ils le pourront. 56 | -------------------------------------------------------------------------------- /docs/contribute/reporting-issues.md: -------------------------------------------------------------------------------- 1 | # Rapporter des problèmes 2 | 3 | Papillon est un projet open-source et nous encourageons les utilisateurs à signaler les problèmes qu'ils rencontrent. Cela nous aide à identifier et à résoudre les problèmes plus rapidement, ce qui profite à l'ensemble de la communauté. 4 | 5 | ## Comment signaler des problèmes 6 | 7 | ### Où signaler des problèmes 8 | 9 | !!! github "Sur Github" 10 | Pour signaler un problème sur Github, [ouvrez une nouvelle issue](https://github.com/PapillonApp/Renard/issues) et suivez les instructions pour remplir le formulaire. 11 | 12 | !!! discord "Sur Discord" 13 | Sur le serveur Discord, dans le forum `#🧪┃・bug-report` 14 | 15 | ### Écriture d'un bon rapport de problème 16 | 17 | Si vous rencontrez des problèmes ou des bugs dans l'application Papillon, voici quelques conseils pour signaler des problèmes de manière efficace : 18 | 19 | 1. **Recherchez les problèmes existants** : Avant de signaler un nouveau problème, assurez-vous de rechercher les problèmes existants pour voir si quelqu'un d'autre a déjà signalé le même problème. Cela vous évitera de créer des doublons et permettra de regrouper les informations sur le même problème. 20 | 21 | 2. **Fournissez des informations détaillées** : Lorsque vous signalez un problème 22 | - Indiquez la catégorie du problème (par exemple, bug, amélioration, question). 23 | - Décrivez le problème de manière détaillée, en expliquant ce que vous avez essayé de faire et ce qui s'est mal passé. 24 | - Incluez des captures d'écran ou des extraits de code si cela peut aider à expliquer le problème. 25 | - Indiquez la version de l'application que vous utilisez, ainsi que les étapes pour reproduire le problème. 26 | 27 | 3. **Soyez respectueux** : Lorsque vous signalez un problème 28 | - Soyez respectueux envers les autres contributeurs et les mainteneurs du projet. 29 | - Évitez les commentaires offensants ou les attaques personnelles. 30 | 31 | 4. **Soyez patient** : Lorsque vous signalez un problème ou que vous demandez de l'aide 32 | - Soyez patient et attendez une réponse. 33 | - N'envoyez pas de messages répétés ou de relances. 34 | 35 | !!! failure "Harcèlement interdit" 36 | Il est interdit d'harceler les responsables de la catégorie ou la personne de la coordination pour qu'ils fusionnent votre pull request. Ils prendront le temps d'évaluer votre code et de vous donner des retours dès qu'ils le pourront. 37 | -------------------------------------------------------------------------------- /docs/design/color.md: -------------------------------------------------------------------------------- 1 | # Couleurs 2 | 3 | Les couleurs forment la base de l'identité visuelle de l'application. Elles sont utilisées pour donner une identité visuelle à l'application et pour faciliter la lecture des utilisateurs. 4 | 5 | ## Les couleurs de la marque 6 | 7 | ### Couleurs principales 8 | 9 | Les couleurs principales sont utilisées pour les éléments visuels importants de l'identité de marque. Elles sont utilisées pour les éléments visuels importants de l'application et de communication. 10 | 11 |
12 |
13 |
17 |

Vert Papillon

18 |

#2A937A

19 |
20 |
21 |
25 |

Vert secondaire

26 |

#32AB8E

27 |
28 |
29 | 30 | ### Couleurs secondaires 31 | 32 | Les couleurs secondaires sont utilisées pour identifier et démarquer des élements précis de l'interface utilisateur ou de la communication, afin de créer des variations. 33 | 34 |
35 |
36 |
40 |

Indigo

41 |

#565EA3

42 |
43 |
44 |
48 |

Minuit

49 |

#2E4277

50 |
51 |
52 |
56 |

Moutarde

57 |

#B18619

58 |
59 |
60 |
64 |

Bordeaux

65 |

#B42828

66 |
67 |
68 |
72 |

Corail

73 |

#A84700

74 |
75 |
76 |
80 |

Bleu

81 |

#0065A8

82 |
83 |
84 |
88 |

Cyan

89 |

#77FFFF

90 |
91 |
92 |
96 |

Néon

97 |

#0DFF8B

98 |
99 |
100 |
104 |

Jaune

105 |

#FDC500

106 |
107 |
108 | 109 | ### Calques de transparences 110 | 111 | Les calques de transparence sont utilisés pour une monochromie des couleurs. Ils sont utilisés sur quelques supports. 112 | 113 |
114 |
115 |
119 |

"Le 10%"

120 |

#FFFFFF10

121 |
122 |
123 |
127 |

"Le 50%"

128 |

#FFFFF50

129 |
130 |
131 | 132 | ## Utilisations des couleurs 133 | 134 | 135 | !!! note warning "Utilisations des couleurs par rapport au support" 136 | **Papillon a deux moyens d'utilisés les couleurs et calques, nous faisons la différence entre communication publique & ouverte, et la communication officielle & privée**. 137 | Cela se fait par l'utilisation [des couleurs secondaires](#couleurs-secondaires) ou [des calques de transparence.](#calques-de-transparences) 138 | 139 | ### Thème clair 140 | 141 |
142 |
143 |
147 |

Fond primaire

148 |

#FFFFFF

149 |

UIColors.background

150 |
151 |
152 |
156 |

Fond secondaire

157 |

#F3F2F8

158 |

UIColors.modalBackground

159 |
160 |
161 | 162 | ### Thème sombre 163 | 164 |
165 |
166 |
170 |

Fond primaire

171 |

#0B0B0C

172 |

UIColors.background

173 |
174 |
175 |
179 |

Fond secondaire

180 |

#161618

181 |

UIColors.modalBackground

182 |
183 |
184 | 185 | ### Thème Full Black 186 | 187 | !!! note warning "Utilisations du thème Full Black" 188 | Le thème Full Black est très peu utilisé pour Papillon, il est présent pour widget les modes nuits sur iPhone. En **Aucun cas** il doit 189 | être utilisé pour designer une interface. Ce thème a uniquement pour but les widgets, le [Standby Mode](https://support.apple.com/fr-fr/guide/iphone/iph878d77632/ios) 190 | et l'utilisation dans de très rare cas de prototype hors iPhone. 191 | 192 |
193 |
194 |
198 |

Fond primaire

199 |

#000000

200 |
201 |
202 |
206 |

Couleur secondaire

207 |

#F00304

208 |
209 |
210 | 211 | 287 | -------------------------------------------------------------------------------- /docs/design/communication-kit.md: -------------------------------------------------------------------------------- 1 | # Kit de communication 2 | Communiquez autour de Papillon dans vos projets et collaborations grâce au kit de communication Papillon. 3 | 4 | ## Charte graphique (PDF) 5 | [Charte Graphique - Papillon (sept. 2023).pdf](https://cdn.tryon-lab.fr/Charte%20Graphique%20-%20Papillon%20(sept.%202023).pdf) 6 | -------------------------------------------------------------------------------- /docs/design/font.md: -------------------------------------------------------------------------------- 1 | # Polices d'écriture 2 | 3 | Les polices d'écriture sont utilisées pour les titres, les sous-titres et les textes courants. Elles contribuent à définir l'identité visuelle de l'application et à faciliter la lecture des utilisateurs. 4 | 5 |
6 |

7 | Fixel Text 8 |

9 |

10 | Quand jadis, mon vaillant zéphyr explorait les cieux, papillon exquis, s'éveillant aux délices du jardin éternel, le parfum suave annonçait mille bonheurs. 11 |

12 |
13 |

14 | Interface utilisateur 15 |

16 | 17 | Télécharger 18 | 19 |
20 |
21 | 22 |
23 |

24 | Onest 25 |

26 |

27 | Quand jadis, mon vaillant zéphyr explorait les cieux, papillon exquis, s'éveillant aux délices du jardin éternel, le parfum suave annonçait mille bonheurs. 28 |

29 |
30 |

31 | Communication visuelle 32 |

33 | 34 | Télécharger 35 | 36 |
37 |
38 | 39 |
40 |

41 | Open Dyslexic 42 |

43 |

44 | Quand jadis, mon vaillant zéphyr explorait les cieux, papillon exquis, s'éveillant aux délices du jardin éternel, le parfum suave annonçait mille bonheurs. 45 |

46 |
47 |

48 | Accessibilité 49 |

50 | 51 | Télécharger 52 | 53 |
54 |
55 | 56 | 124 | -------------------------------------------------------------------------------- /docs/design/font_old.md: -------------------------------------------------------------------------------- 1 | # Polices d'écriture 2 | 3 | Les polices d'écriture sont utilisées pour les titres, les sous-titres et les textes courants. Elles contribuent à définir l'identité visuelle de l'application et à faciliter la lecture des utilisateurs. 4 | 5 | ## Cas d'utilisation 6 | 7 | ### Dans l'application principale 8 | 9 | Fixel Text est utilisée comme police par défaut pour l'ensemble de l'application. Elle est utilisée pour les titres, les sous-titres et les textes courants. 10 | 11 | ### Dans les "targets" natives 12 | 13 | Pour les "targets" natives, les polices d'écriture par défaut de la plateforme doivent être utilisées. 14 | 15 | Exemple : San Francisco pour WatchOS. 16 | 17 |
18 | 19 | !!! note success "Ce que vous devez faire" 20 | ![AWT](../assets/design/font/AWT.svg){ width="100%" } 21 | En respectant les polices d'écriture par défaut de la plateforme, vous garantissez une expérience utilisateur harmonieuse. Cela permet également de maintenir une cohérence visuelle entre les différentes applications de la plateforme. Enfin, l'accessibilité de l'application est améliorée. 22 | 23 | !!! note failure "Ce que vous ne devez pas faire" 24 | ![AWF](../assets/design/font/AWF.svg){ width="100%" } 25 | Il est interdit d'utiliser des polices d'écriture autres que celles par défaut de la plateforme. Cela pourrait nuire à l'expérience utilisateur ainsi qu'à l'accessibilité de l'application. 26 | 27 |
28 | 29 | ## Liens de téléchargement 30 | 31 |
32 | 33 | - :octicons-typography-24:{ .lg .middle } __Fixel Text__ 34 | 35 | --- 36 | 37 | Fixel Text est utilisée comme police par défaut pour l'ensemble de l'application. Elle est utilisée pour les titres, les sous-titres et les textes courants. 38 | 39 | Licence : [Open Font License](https://github.com/MacPaw/Fixel/blob/main/OFL.txt) 40 | 41 | [:octicons-move-to-bottom-24: Télécharger](https://github.com/MacPaw/Fixel/tree/main/fonts/ttf){target="_blank"} 42 | 43 | - :octicons-typography-24:{ .lg .middle } __Miriam Libre__ 44 | 45 | --- 46 | 47 | Cette police est utilisée plus occasionnellement pour certains éléments. Elle est à utiliser avec parcimonie. 48 | 49 | Licence : [Open Font License](https://openfontlicense.org) 50 | 51 | [:octicons-move-to-bottom-24: Télécharger](https://fonts.google.com/specimen/Miriam+Libre){target="_blank"} 52 | 53 |
54 | -------------------------------------------------------------------------------- /docs/design/intro.md: -------------------------------------------------------------------------------- 1 | # Introduction 2 | > Papillon est conçu pour être facile à utiliser tout en offrant une expérience agréable aux utilisateurs. En tant que surcouche graphique aux clients scolaires habituels, Papillon se doit de fournir une expérience utilisateur optimisée pour son usage. 3 | 4 | !!! note warning "Un niveau de connaissance est requis" 5 | Cette section est destinée aux designers ayant un niveau de connaissance suffisant pour comprendre les concepts de base de la conception d'interface utilisateur et de l'expérience utilisateur. 6 | 7 | ## Avant de commencer 8 | 9 | L'application Papillon dispose déjà d'une charte graphique préétablie. Il est donc nécessaire de s'en approcher au maximum lors de la conception et du design de l'application. Cela garantira une cohérence visuelle et une expérience utilisateur harmonieuse. 10 | 11 | De plus, Papillon utilise **[les guides d’interface utilisateur d’Apple](https://developer.apple.com/design/)** comme base de règles et de principes sur lesquels développer. De ce fait, les écrans d’UI présents sur ce Figma prennent iOS comme système d’exploitation. 12 | 13 | Merci de prendre en compte cette charte graphique lors de la création des éléments visuels de l'application. 14 | 15 | ## Chartes graphiques 16 | 17 | Pour faciliter la conception du design de l'application, nous vous recommandons d'utiliser le fichier Figma suivant : 18 | 19 | - [Papillon Product Design (PPD) :octicons-link-external-24:](https://www.figma.com/file/EZ9HbmMmCywyCxp3OuvofF/%5BPUBLIC%5D-Papillon-Product-Design?type=design&node-id=0-1&mode=design&t=xcRjRMwqy4sVpscj-0){target="_blank"} 20 | 21 | - [**OUTDATED** Charte graphique (PDF) :octicons-link-external-24:](../assets/design/Charte%20Graphique%20-%20Papillon%20(sept.%202023).pdf){target="_blank"} 22 | 23 | Ces fichiers contiennent les éléments visuels de l'application, tels que les couleurs, les typographies, les icônes et les composants. Ils sont mis à jour régulièrement pour refléter les dernières modifications apportées à l'application. Vous ne pouvez pas directement modifié le fichier & Figma d'origine mais vous pouvez les dupliquer pour apporter vos modifications. 24 | 25 | **Toutes utilisations d'un élément graphique de Papillon et de PapillonApp sont soumis à la license GPL 3.0, ce qui signifie que vous devez quand même créditer Papillon & PapillonApp en cas d'utilisations n'ayant pas de rapport avec le projet Github d'origine.** 26 | -------------------------------------------------------------------------------- /docs/design/logotype.md: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/PapillonApp/old-docs/b4fcfd2318fe45550eabc74bf623be0e40e9e565/docs/design/logotype.md -------------------------------------------------------------------------------- /docs/development/api/ed/api.md: -------------------------------------------------------------------------------- 1 | # EcoleDirecte Api - Documentation 2 | 3 | !!! github "Merci à MaitreRouge pour la doc" 4 | Vous pouvez retrouver la documentation originale sur [GitHub :octicons-link-external-24:](https://github.com/EduWireApps/ecoledirecte-api-docs/blob/main/README.md){target='_blank'} 5 | 6 | 7 | ## Introduction 8 | 9 | 10 | Bienvenue sur la documentation non officielle de l'api d'ecoledirecte. 11 | 12 | Si jamais cette documentation vient a être défaillante, merci de faire une issue avec les problèmes rencontrés 13 | 14 | (Si jamais vous avez des idées de formatage, hésitez pas à me le faire savoir [MaitreRouge#6916](https://discord.gg/EHM7jubSvE)) 15 | 16 | 17 | ## Index 18 | 19 | 20 | Juste un rapide sommaire pour naviguer plus facilement dans la documentation. 21 | 22 | - [Format de la documentation](#format-de-la-documentation) 23 | - [Utilisation de l'API](#utilisation-de-lapi) 24 | - [Requêtes authentifiées](#requêtes-authentifiées) 25 | - [Codes erreur](#codes-erreur) 26 | - [Servers.json](#serversjson) 27 | 28 | * [Login](#login) 29 | * [Account objects](#accounts-objects) 30 | * [Modules](#account-modules) 31 | * [Élève](#élève) 32 | * [Timeline](#timeline) 33 | * [Timeline commune](#timeline-commune) 34 | * [Sondages](#sondages) 35 | * [Formulaires](#formulaires) 36 | * [Visios](#visios) 37 | * [Emploi du temps](#emploi-du-temps) 38 | * [Cahier de texte](#cahier-de-texte) 39 | * [Vie scolaire](#vie-scolaire) 40 | * [Carnet de correspondance](#carnet-de-correspondance) 41 | * [Documents administratifs](#documents-administratifs) 42 | * [Notes](#notes) 43 | * [Espaces de travail](#espaces-de-travail) 44 | * [Manuels numériques](#manuels-numériques) 45 | * [QCMs](#qcms) 46 | * [Commandes](#commandes) 47 | * [Classe](#classe) 48 | * [Vie de la classe](#vie-de-la-classe) 49 | * [Cloud](#cloud) 50 | * [Chemins](#chemins) 51 | * [Cloud élève](#cloud-élève) 52 | * [Cloud espaces de travail](#cloud-espaces-de-travail) 53 | * [Téléversement](#téléversement) 54 | * [Téléchargement](#téléchargement) 55 | 56 | 57 | ## Format de la documentation 58 | 59 | La base de l'api élève est ``https://api.ecoledirecte.com/``. Toutes les URLs relatives sont relatives à cette base. 60 | 61 | Les requêtes prennent généralement des paramètres soit en *query string* dans l'URL soit en JSON dans le corps de la requête. Ces paramètres sont encodés au format `application/x-www-form-urlencoded`, bien que cet encodage soit totalement optionnel pour le corps de la requête. 62 | 63 | **Note** : On peut utiliser la fonction `encodeURIComponent()` en JavaScript et `urllib.parse.quote()` en Python pour encoder ces paramètres. 64 | 65 | **Exemple** : Votre mot de passe est `JaimeLesK++kies&Ynotes` il faudra envoyer `JaimeLesK%2B%2Bies%26` 66 | 67 | **Important** : Toutes les requêtes sont faites en `POST`. Elles prennent aussi un paramètre `verbe` utilisé pour spécifier le verbe HTTP. Ici ce paramètre est omis et la méthode HTTP indiquée est en réalité la valeur du paramètre `verbe` (l'exemple est plus clair). 68 | 69 | Les réponses suivent généralement le format suivant, et tout schéma de réponse donné correspond en réalité à celui de la valeur de `data` : 70 | 71 | ```jsonc 72 | { 73 | "host": "HTTP", 74 | "code": 200, // Ou autre en cas d'erreur 75 | "token": "", 76 | "message": "", // Rarement présent hors erreur, sinon en cas d'erreur 77 | "data": {...}, 78 | } 79 | ``` 80 | 81 | ### Exemple 82 | 83 | __GET__ `/v3/eleves/{eleve.id}/messages/{message.id}.awp` 84 | 85 | Avec les paramètres de recherche `mode=destinataire` et les paramètres en JSON `{ "anneeMessages": "2021-2022" }` 86 | 87 | Correspond à la requête 88 | 89 | __POST__ `https://api.ecoledirecte.com/v3/eleves/{élève.id}/messages/{message.id}.awp?verbe=get&mode=destinataire` avec le corps `data={ "anneeMessages": "2021-2022" }` ou bien sous forme encodée `data=%7B%20%22anneeMessages%22%3A%20%222021-2022%22%20%7D` 90 | 91 | 92 | ## Utilisation de l'API 93 | 94 | ### NOTE IMPORTANTE : 95 | 96 | Avant tout, merci d'ajouter un user-agent dans vos headers pour "faire croire" à ED que vous utilisez un "vrai" navigateur pour faire vos requetes ! 97 | 98 | Il faut savoir que si vous utilisez un useragent pour obtenir un token, il faudra utiliser le même useragent avec ce token. Si jamais un autre UA est utilisé, le token sera invlidé. 99 | 100 | Si vous n'avez pas d'idée en voici un : 101 | ``` 102 | Mozilla/5.0 (Windows NT 10.0; Win64; x64) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/109.0.0.0 Safari/537.36 103 | ``` 104 | 105 | ### Requêtes authentifiées 106 | 107 | Cela concerne toutes les routes à l'exception de `/login`. Il faut passer un `Header` à la requête avec le token (voir [login](#login)): 108 | 109 | ``` 110 | X-Token: 111 | ``` 112 | 113 | 114 | ### Codes erreur 115 | 116 | Liste de differents codes erreur trouvés au fil du temps avec leur description et des solutions pour fixer le pb 117 | 118 | *Note : Les requêtes renveront (sauf grosse erreur côté serveur avec une 5xx) toujours dans leur header un code 200, même en cas d'erreur* 119 | 120 | ``` 121 | Code: 505 122 | Problème: Les identifiants donnés à l'api sont erronés 123 | Solution: Il faut vérifier le nom d'utilisateur et/ou le mot de passe (cf Login) 124 | 125 | Code: 520 126 | Problème: Le token est invalide 127 | Solution: Il faut regénérer un token (cf Login) 128 | 129 | Code: 525 130 | Problème: Le token est expiré 131 | Solution: Il faut regénérer un token (cf Login) 132 | 133 | Code: 40129 134 | Problème: Format JSON invalide 135 | Solution: Vérifier que le body de la requete a bien été envoyé en raw (ou plain text) et qu'il respecte le formatage donné dans la documentation 136 | ``` 137 | 138 | 139 | 140 | 141 | ### Servers.json 142 | 143 | EcoleDirecte n'utilise pas qu'un seul serveur, il est possible d'obtenir des informations sur les serveurs du site en une seule requête. 144 | La raison pour laquelle cette partie est incluse dans la section de référence réside dans le fait que cela n'a pas véritablement d'utilité à être abordé en profondeur. 145 | 146 | *Notes : Il semblerait que le fichier soit statique :c (les pings sont les mêmes depuis que j'ai commencé la doc)* 147 | 148 | Voici le lien du fichier : [https://www.ecoledirecte.com/EDCluster/servers.json](https://www.ecoledirecte.com/EDCluster/servers.json) 149 | 150 | Échantillon du fichier : 151 | ```js 152 | { 153 | "servers": [ //On va recevoir une liste d'objets comme celui ci dessous 154 | { 155 | "profile": "API", //string | Alterne entre API / APIP et ALL 156 | "lastCheck": "Mon Mar 16 2020 20:55:47 GMT+0100 (CET)", // la dernière fois où le serveur a été vérifié 157 | "name": "api.ecoledirecte.com", //string | url du serveur 158 | "ip": "213.32.36.118", //string | ip du serveur 159 | "status": 1,//int | si le serveur est bien en ligne 160 | "responseTime": 338.23671800643206, //float | ping 161 | "weigth": 3, //int | ??? 162 | "timeout": false, //bool | Si le serveur a timeout 163 | "version": "Maj du 16/03/2020 à 16h27", //string, version logicielle du serveur 164 | "bdTested": "95", //string | ??? 165 | "elapsedTime": 338, //int | ??? 166 | "timingPhases": { //Object representatant la latence avec des détails 167 | "wait": 78.6058100014925, 168 | "dns": 3.143696002662182, 169 | "tcp": 7.182815000414848, 170 | "firstByte": 249.2012169957161, 171 | "download": 0.10318000614643097, 172 | "total": 338.23671800643206 173 | }, 174 | "timings": { 175 | "socket": 78.6058100014925, 176 | "lookup": 81.74950600415468, 177 | "connect": 88.93232100456953, 178 | "response": 338.1335380002856, 179 | "end": 338.23671800643206 180 | }, 181 | "httptested": "HTTP76", 182 | "nbConnexions": 1,//int | Nombre d'utilisateur connectés ?? 183 | "errorCode": "ESOCKETTIMEDOUT" 184 | }, 185 | ], 186 | } 187 | ``` 188 | 189 | ---- 190 | 191 | Ici se trouve toute la documentation, assurez-vous d'avoir lu la référence avant de commencer. 192 | 193 | ## Login 194 | 195 | __POST__ `/v3/login.awp` 196 | 197 | Data en body : 198 | ```json 199 | { 200 | "identifiant": "Username", 201 | "motdepasse": "Password", 202 | "isRelogin": false, 203 | "uuid": "" 204 | } 205 | ``` 206 | 207 | Différents exemples de réponses complètes. Elles suivent le modèle de réponse donné dans la référence. 208 | 209 |
210 | Succès 211 | 212 | ```js 213 | { 214 | "code": 200, 215 | "token": "Super secret token here", //Token de connexion (+3100 long) 216 | "message": "", //Utilisé pour afficher des messages d'erreur 217 | "data": { 218 | "accounts": [ 219 | // Liste d'utilisateur liés au compte, voir la référence pour plus 220 | ] 221 | } 222 | } 223 | ``` 224 |
225 | 226 |
227 | Erreur (Mot de passe invalide) 228 | 229 | ```js 230 | { 231 | "code": 505, 232 | "token": "", //Toujours vide en cas d'erreur 233 | "message": "Mot de passe invalide !", 234 | "data": { 235 | "accounts": [] 236 | } 237 | } 238 | ``` 239 |
240 | 241 |
242 | Erreur (Utilisateur introuvable) 243 | 244 | ```js 245 | { 246 | "code": 505, 247 | "token": "", //Toujours vide en cas d'erreur 248 | "message": "Identifiant et/ou mot de passe invalide !", 249 | "data": { 250 | "accounts": [] 251 | } 252 | } 253 | ``` 254 |
255 | 256 | 257 | ### Accounts objects 258 | 259 | Voici la structure détaillée d'un utilisateur (et commentée) qui est contenu sous la clé `data` de la réponse. 260 | 261 | ```js 262 | { 263 | "idLogin": 1324, //int | Paramètre de cookie pour savoir si l'utilisateur est connecté via login/password 264 | "id": 1234, //int | Numéro de compte 265 | "uid": "00000000000000000000000000000000", //string | Il ne sert à rien lui aussi 266 | "identifiant": "Username", //string | Username du compte 267 | "typeCompte": "E", //string | Voir Type de compte dans la référence 268 | "codeOgec": "000000000", //string | Code RNE de l'établissement scolaire du compte 269 | "main": true, //bool | Indique si ce compte est le compte principal de la famille(il peut en avoir plusieur comme avec un parent) 270 | "lastConnexion": "2021-10-05 18:28", //string | Date de dernière connexion à l'api via l'endpoint login (multiples connexions possibles) 271 | "civilite": "", 272 | "prenom": "John", 273 | "particule": "", 274 | "nom": "DOE", 275 | "email": "email@example.com", 276 | "anneeScolaireCourante": "2050-2051", 277 | "nomEtablissement": "Github", 278 | "logoEtablissement": "", 279 | "couleurAgendaEtablissement": "#1796b0", 280 | "dicoEnLigneLeRobert": false, 281 | "socketToken": "secret token", //string | Websocket, à priori il n'est pas prit en compte concernant l'authentification (si on le change on ne sera pas déconnecté) 282 | "modules": [ 283 | // Liste des modules 284 | ], 285 | "parametresIndividuels": { 286 | "lsuPoilDansLaMainBorne1": "", // int | Paramètre parcoursup 287 | "lsuPoilDansLaMainBorne2": "", // int | Paramètre parcoursup 288 | "lsuPoilDansLaMainBorne3": "", // int | Paramètre parcoursup 289 | "modeCalculLSU": "", // ??? | Paramètre de recommandation parcoursup 290 | "isQrcode": false, // ??? 291 | "accessibilitéVisuelle": false, // bool | Pour les personnes malvoyantes, une police spéciale est mise en place 292 | "typeSaisieNotesDefaut": "", 293 | "nbJoursMaxRenduDevoirCDT": "", 294 | "typeViewCDTDefaut": "" 295 | }, 296 | "profile": { 297 | "sexe": "M", 298 | "infoEDT": "", 299 | "nomEtablissement": "Github", 300 | "idEtablissement": "0", 301 | "rneEtablissement": "0000000", 302 | "telPortable": "", 303 | "idReelEtab": "0", 304 | "photo": "//doc1.ecoledirecte.com/PhotoEleves/x/y.jpg", 305 | "classe": { 306 | "id": 44, 307 | "code": "TB", 308 | "libelle": "Terminale B", 309 | "estNote": 1 310 | } 311 | } 312 | } 313 | ``` 314 | 315 | ### Account modules 316 | 317 | Ces modules là sont ceux disponibles dans l'object account, ils ressemblent à ça : 318 | 319 | ```js 320 | { 321 | "code": "CANTINE_BARCODE", //string | Nom du module 322 | "enable": false, //bool | Si le module est actif pour l'account en question 323 | "ordre": 1, //int | Position dans la sidebar 324 | "badge": 0, //int | ??? 325 | "params": {} //object | Parametres du modules 326 | } 327 | ``` 328 | 329 | Voici la liste des modules qui ont été documentés jusqu'a présent 330 | 331 | ```js 332 | { 333 | "code": "CANTINE_BARCODE", 334 | "enable": false, 335 | "ordre": 1, 336 | "badge": 0, 337 | "params": {} 338 | }, 339 | { 340 | "code": "VIE_SCOLAIRE", 341 | "enable": true, 342 | "ordre": 10, 343 | "badge": 0, 344 | "params": {} 345 | }, 346 | { 347 | "code": "VIE_DE_LA_CLASSE", 348 | "enable": true, 349 | "ordre": 20, 350 | "badge": 0, 351 | "params": {} 352 | }, 353 | { 354 | "code": "NOTES", 355 | "enable": true, 356 | "ordre": 30, 357 | "badge": 0, 358 | "params": {} 359 | }, 360 | { 361 | "code": "CLOUD", 362 | "enable": false, 363 | "ordre": 90, 364 | "badge": 0, 365 | "params": {} 366 | }, 367 | { 368 | "code": "MESSAGERIE", 369 | "enable": true, 370 | "ordre": 40, 371 | "badge": 0, 372 | "params": { 373 | "isActif": "1", 374 | "canParentsLireMessagesEnfants": "1", 375 | "destAdmin": "0", 376 | "destEleve": "0", 377 | "destFamille": "0", 378 | "destProf": "1", 379 | "destEspTravail": "0", 380 | "disabledNotification": "0", 381 | "notificationEmailEtablissement": "1", 382 | "choixMailNotification": "0", 383 | "autreMailNotification": "", 384 | "mailPro": "", 385 | "mailPerso": "", 386 | "messagerieApiVersion": "v3", 387 | "blackListProfActive": "0", 388 | "estEnBlackList": "0", 389 | "afficherToutesLesClasses": "0" 390 | } 391 | }, 392 | { 393 | "code": "EDT", 394 | "enable": true, 395 | "ordre": 50, 396 | "badge": 0, 397 | "params": {} 398 | }, 399 | { 400 | "code": "DOCUMENTS_ELEVE", 401 | "enable": true, 402 | "ordre": 71, 403 | "badge": 0, 404 | "params": { 405 | "DocumentsNotesActif": "1", 406 | "DocumentsVSActif": "1", 407 | "DocumentsAdministratifActif": "1" 408 | } 409 | }, 410 | { 411 | "code": "CAHIER_DE_TEXTES", 412 | "enable": true, 413 | "ordre": 60, 414 | "badge": 0, 415 | "params": { 416 | "compteRenduSeance": "1", 417 | "compteRenduSeancePrevisionnel": "0", 418 | "isCDTPrimaire": "0" 419 | } 420 | }, 421 | { 422 | "code": "MANUELS_SCOLAIRES", 423 | "enable": false, 424 | "ordre": 62, 425 | "badge": 0, 426 | "params": {} 427 | }, 428 | { 429 | "code": "QCM", 430 | "enable": true, 431 | "ordre": 65, 432 | "badge": 0, 433 | "params": {} 434 | }, 435 | { 436 | "code": "RESERVATIONS", 437 | "enable": false, 438 | "ordre": 80, 439 | "badge": 0, 440 | "params": { 441 | "regime": "Externe", 442 | "repasmidi_1": "0", 443 | "repassoir_1": "0", 444 | "repasmidi_2": "0", 445 | "repassoir_2": "0", 446 | "repasmidi_3": "0", 447 | "repassoir_3": "0", 448 | "repasmidi_4": "0", 449 | "repassoir_4": "0", 450 | "repasmidi_5": "0", 451 | "repassoir_5": "0", 452 | "repasmidi_6": "0", 453 | "repassoir_6": "0", 454 | "repasmidi_7": "0", 455 | "repassoir_7": "0" 456 | } 457 | }, 458 | { 459 | "code": "COMMANDE_PASSAGE", 460 | "enable": false, 461 | "ordre": 81, 462 | "badge": 0, 463 | "params": {} 464 | }, 465 | { 466 | "code": "CARNET_CORRESPONDANCE", 467 | "enable": false, 468 | "ordre": 70, 469 | "badge": 0, 470 | "params": {} 471 | }, 472 | { 473 | "code": "ESIDOC", 474 | "enable": false, 475 | "ordre": 110, 476 | "badge": 0, 477 | "params": {} 478 | }, 479 | { 480 | "code": "EDUNAO", 481 | "enable": false, 482 | "ordre": 100, 483 | "badge": 0, 484 | "params": {} 485 | }, 486 | { 487 | "code": "CATER", 488 | "enable": false, 489 | "ordre": 90, 490 | "badge": 0, 491 | "params": {} 492 | }, 493 | { 494 | "code": "ARD", 495 | "enable": false, 496 | "ordre": 120, 497 | "badge": 0, 498 | "params": {} 499 | }, 500 | { 501 | "code": "PEARLTREES", 502 | "enable": false, 503 | "ordre": 170, 504 | "badge": 0, 505 | "params": {} 506 | }, 507 | { 508 | "code": "EDUMALIN", 509 | "enable": false, 510 | "ordre": 171, 511 | "badge": 0, 512 | "params": {} 513 | }, 514 | { 515 | "code": "SUIVI_STAGE", 516 | "enable": false, 517 | "ordre": 43, 518 | "badge": 0, 519 | "params": {} 520 | }, 521 | { 522 | "code": "CLICKNPLAY", 523 | "enable": false, 524 | "ordre": 171, 525 | "badge": 0, 526 | "params": {} 527 | }, 528 | { 529 | "code": "VOLTAIRE", 530 | "enable": false, 531 | "ordre": 175, 532 | "badge": 0, 533 | "params": {} 534 | }, 535 | { 536 | "code": "ONISEPSERVICES", 537 | "enable": false, 538 | "ordre": 172, 539 | "badge": 0, 540 | "params": {} 541 | }, 542 | { 543 | "code": "AVENRIA", 544 | "enable": false, 545 | "ordre": 173, 546 | "badge": 0, 547 | "params": {} 548 | }, 549 | { 550 | "code": "SACOCHE", 551 | "enable": false, 552 | "ordre": 174, 553 | "badge": 0, 554 | "params": {} 555 | }, 556 | { 557 | "code": "ETUDIANT", 558 | "enable": false, 559 | "ordre": 176, 560 | "badge": 0, 561 | "params": {} 562 | }, 563 | { 564 | "code": "IJBOX", 565 | "enable": false, 566 | "ordre": 177, 567 | "badge": 0, 568 | "params": {} 569 | }, 570 | { 571 | "code": "FUTURNESS", 572 | "enable": false, 573 | "ordre": 178, 574 | "badge": 0, 575 | "params": {} 576 | }, 577 | { 578 | "code": "IMPALA", 579 | "enable": false, 580 | "ordre": 179, 581 | "badge": 0, 582 | "params": {} 583 | }, 584 | { 585 | "code": "SITUATION_FINANCIERE", 586 | "enable": false, 587 | "ordre": 92, 588 | "badge": 0, 589 | "params": {} 590 | } 591 | ``` 592 | 593 | 594 | ## Élève 595 | 596 | ### Timeline 597 | 598 | Je sais pas qui aurait besoin de la timeline mais bon (: 599 | 600 | __GET__ `/v3/eleves/{id}/timeline.awp` 601 | 602 | Data dans la réponse : 603 | ```js 604 | [ //Liste des évènements relatif au compte (quelques exemples d'évènement peuvent être trouvés) 605 | { 606 | "date": "2021-12-05", //String | Date de l'evènement 607 | "typeElement": "Note", //String | Type de l'event (Note / Abscence / Document / Messagerie / VieScolaire / ...) 608 | "idElement": 0, // identifiant du message / evt de vie scolaire / document associé 609 | "titre": "Nouvelle évaluation", //String | Titre de l'evenement 610 | "soustitre": "ED.PHYSIQUE & SPORT.", 611 | "contenu": "natation du 15/11/2021" //String | Contenu de l'evenement 612 | }, 613 | { 614 | "date": "2021-09-20", 615 | "typeElement": "VieScolaire", 616 | "idElement": 527, 617 | "titre": "Absence", 618 | "soustitre": "2 demi-journées", 619 | "contenu": "Justifiée" 620 | }, 621 | { 622 | "date": "2021-09-17", 623 | "typeElement": "Document", 624 | "idElement": 2538, 625 | "titre": "Nouveau document à télécharger", 626 | "soustitre": "", 627 | "contenu": "Invitation 50 ans" 628 | }, 629 | { 630 | "date": "2021-09-09", 631 | "typeElement": "Document", 632 | "idElement": 1144, 633 | "titre": "Nouveau document à télécharger", 634 | "soustitre": "", 635 | "contenu": "Certificat de scolarité" 636 | } 637 | ] 638 | ``` 639 | 640 | ### Timeline commune 641 | 642 | __GET__ `/v3/E/{id}/timelineAccueilCommun.awp` 643 | 644 | C'est la timeline de l'établissement que tous les élèves voient. Elle inclue les post-its. 645 | 646 | Data dans la réponse : 647 | ```typescript 648 | { 649 | "evenements": [], // ? 650 | "postits": Array<{ 651 | "id": number, 652 | "type": string, // "info", ? 653 | "contenu": string // HTML encodé en base64 654 | "dateCreation": "JJ/MM/AAAA", 655 | "dateDebut": "JJ/MM/AAAA", 656 | "dateFin": "JJ/MM/AAAA", 657 | "cible": [], // ? 658 | "ciblesEtab": [], // ? 659 | "auteur": { 660 | "civilite": string, // M. 661 | "prenom": string, 662 | "particule": string, 663 | "nom": string, 664 | "type": string, // "A", ? 665 | "id": string, // Identifiant de la personne 666 | }, 667 | }>, 668 | } 669 | ``` 670 | 671 | ### Sondages 672 | 673 | __GET__ `/v3/rdt/sondages.awp` 674 | 675 | J'ai eu une réponse avec une liste vide dans `data` donc réponse inconnue. 676 | 677 | ### Formulaires 678 | 679 | __LIST__ `/v3/edforms.awp` 680 | 681 | Ici aussi, une liste vide donc réponse inconnue. 682 | 683 | ### Visios 684 | 685 | __GET__ `/v3/E/{id}/visios.awp` 686 | 687 | Pas de visios ici non plus donc réponse inconnue. 688 | 689 | ### Emploi du temps 690 | 691 | Le titre est plutot clair non ? 692 | 693 | *Note : Si jamais le temps est incorrect alors data sera juste un array vide* 694 | 695 | __GET__ `/v3/E/{id}/emploidutemps.awp` 696 | 697 | Data en body : 698 | ```json 699 | { 700 | "dateDebut": "2021-12-15", 701 | "dateFin": "2021-12-15", 702 | "avecTrous": false 703 | } 704 | ``` 705 | 706 | Data dans la réponse : 707 | ```js 708 | [ 709 | { 710 | "id": 46234, //int | Semble être un identifiant unique du cours 711 | "text": "NUMERIQUE SC.INFORM.", //string | Nom du cours (peut diférer de la matière) 712 | "matiere": "NUMERIQUE SC.INFORM.", 713 | "codeMatiere": "NSINF", //string | Code matière interne au service ED 714 | "typeCours": "COURS", //string | Semble varier (COURS / PERMANENCE) 715 | "start_date": "2021-12-15 08:00", 716 | "end_date": "2021-12-15 08:55", 717 | "color": "#91b2bc", //string | Couleur hex du cours sur l'edt 718 | "dispensable": false, //string | Si l'élève doit se rendre en cours 719 | "dispense": 0, //int | Rhalala, le sport (: 720 | "prof": "MaitreRouge", 721 | "salle": "SALLE 11 INFO", 722 | "classe": "", //string | vide si est dispensé dans plusieures classes 723 | "classeId": 0, //int | ID de la classe dans laquelle le cours est dispensé (0 si est dispensé dans plusieures classes) 724 | "classeCode": "", //int | Code de la classe (je pense qu'on a compris avec le temps que c'était vide si la cours était dispensé dans plusieures classes) 725 | "groupe": "T_NSINF-1", //string | Nom du groupe (si dispensé dans plusieures classes) 726 | "groupeCode": "T_NSINF-1",//string | Code du groupe 727 | "isFlexible": false, //bool | ??? 728 | "groupeId": 2004, //int | ID du groupe 729 | "icone": "", //string | Depuis quand on peut avoir des icones ? 730 | "isModifie": false, //bool | ??? 731 | "contenuDeSeance": false, //bool | false même si du contenu est posté 732 | "devoirAFaire": false, //bool | false même si un devoir est posté 733 | "isAnnule": false //bool | Si le cours est annulé (franglais dégeu) 734 | }, 735 | { 736 | "id": 78905, 737 | "text": "ANGLAIS LV1", 738 | "matiere": "ANGLAIS LV1", 739 | "codeMatiere": "AGL1", 740 | "typeCours": "COURS", 741 | "start_date": "2021-12-15 10:00", 742 | "end_date": "2021-12-15 10:55", 743 | "color": "#ff66cc", 744 | "dispensable": false, 745 | "dispense": 0, 746 | "prof": "Florian L", 747 | "salle": "SALLE 44", 748 | "classe": "Terminale B", 749 | "classeId": 44, 750 | "classeCode": "TB", 751 | "groupe": "", 752 | "groupeCode": "", 753 | "isFlexible": false, 754 | "groupeId": 0, 755 | "icone": "", 756 | "isModifie": false, 757 | "contenuDeSeance": false, 758 | "devoirAFaire": false, 759 | "isAnnule": false 760 | } 761 | ] 762 | ``` 763 | 764 | ### Cahier de texte 765 | 766 | __GET__ `/v3/Eleves/{id}/cahierdetexte.awp` 767 | 768 | Donne les devoirs à faire à partir d'aujourd'hui (onglet *à faire*). 769 | 770 | Data dans la réponse : 771 | ```typescript 772 | { 773 | "AAAA-MM-JJ": Array<{ 774 | matiere: string, // Nom d'affichage ("FRANCAIS" / "ENSEIGN.SCIENTIFIQUE") 775 | codeMatiere: string, // Code ("FRANC" / "G-SCI") 776 | aFaire: true, // ? 777 | idDevoir: number, 778 | documentsAFaire: false, // ? 779 | donneLe: "AAAA-MM-JJ", 780 | effectue: bool, // Si marqué par l'élève comme tel ? 781 | interrogation: bool, 782 | rendreEnLigne: bool, // Si présence d'un formulaire pour rendre un fichier ? 783 | }>, 784 | } 785 | ``` 786 | 787 |
788 | 789 | __GET__ `/v3/Eleves/{id}/cahierdetexte/{AAAA-MM-JJ}.awp` 790 | 791 | Permet d'obtenir le travail à faire en détail et le contenu de séance pour un jour spécifique. 792 | 793 | **Note**: Il y a deux champs contenu de séance, un directement dans la matière et un dans à faire. Je suspecte que celui dans à faire soit prévu avant la séance alors que celui directement dans la matière soit renseigné après les faits. 794 | 795 | Je vérifierai la différence quand EcoleDirecte sera à nouveau fonctionnel et que j'aurai un exemple des deux. 796 | 797 | - Les données à l'intérieur des clés `contenu` sont encodées en base64. Une fois décodées, on obtient le contenu en HTML dans une balise `

`. 798 | 799 | Data dans la réponse : 800 | ```typescript 801 | { 802 | date: "AAAA-MM-JJ", // Même date que celle passée dans l'URL 803 | matieres: Array<{ 804 | entityCode: string, // Classe ("1A") / groupe 805 | entityLibelle: string, // Nom d'affichage de la classe ("PREMIERE A") 806 | entityType: "C" | "G" | string, // C = Classe, G = Groupe, ... 807 | matiere: string, 808 | codeMatiere: string, // Pareils que route précédente 809 | nomProf: string, 810 | id: number, // Même id que idDevoir dans la route précédente 811 | interrogation: bool, 812 | blogActif: false, // ? 813 | nbJourMaxRenduDevoir: number, // Date butoir du rendu ? 814 | aFaire: { 815 | idDevoir: number, 816 | contenu: string, // Détail du travail à faire 817 | rendreEnLigne: bool, 818 | donneLe: "AAAA-MM-JJ", 819 | effectue: bool, 820 | ressource: "", // ?, vide jusqu'ici 821 | ressourceDocuments: [], // ?, vide jusqu'ici 822 | documents: Array<{ // Pièces jointes 823 | id: number, // Pour la télécharger via la route de téléchargement 824 | libelle: string, // Nom 825 | date: "AAAA-MM-JJ", 826 | taille: number, // En octets 827 | type: "FICHIER_CDT", // Autres valeurs ? 828 | signatureDemandee: false, // ? 829 | signature: {}, // ? 830 | }>, 831 | commentaires: Array<{ 832 | id: number, // identifiant du commentaire 833 | idAuteur: number, // identifiant de l'auteur 834 | profilAuteur: "E", // E = Elève, autres valeurs ? 835 | auteur: string, // Nom de l'auteur 836 | date: "AAAA-MM-JJ", 837 | message: string, // Encodé en base64 838 | supprime: false, // Si le commentaire a été supprimé ? (semble stupide) 839 | }>, 840 | elementsProg: [], // ? 841 | liensManuel: [], // URL des manuels associés à la matière ? 842 | documentsRendus: [], // Fichiers rendus lorsque le formulaire est présent ? 843 | contenuDeSeance: { 844 | contenu: string, 845 | documents: [], 846 | commentaires: [], 847 | }, 848 | }, 849 | contenuDeSeance: { 850 | idDevoir: number, // Systématiquement le même identifiant que id plus haut 851 | contenu: string, 852 | documents: [], // Pièces jointes ? 853 | commentaires: [], // Même structure que commentaires sur travail à faire ? 854 | elementsProg: [], 855 | liensManuel: [], 856 | }, 857 | }> 858 | } 859 | ``` 860 | 861 |
862 | 863 | __PUT__ `/v3/Eleves/{id}/cahierdetexte.awp` 864 | 865 | Marque des devoirs comme faits ou non faits. 866 | 867 | Data en body : 868 | ```typescript 869 | { 870 | idDevoirsEffectues: number[], 871 | idDevoirsNonEffectues: number[], 872 | } 873 | ``` 874 | 875 |
876 | 877 | __POST__ `/v3/eleves/{id}/afaire/commentaires.awp` 878 | 879 | Poste un commentaire sous un travail à faire ou un contenu de séance 880 | 881 | Data en body : 882 | ```typescript 883 | { 884 | message: string, // encodé en base64 885 | idContenu: number, // identifiant du devoir / contenu de séance 886 | } 887 | ``` 888 | 889 | Data dans la réponse : 890 | ```typescript 891 | { 892 | id: number, // Identifiant du commentaire posté 893 | } 894 | ``` 895 | 896 | ### Vie scolaire 897 | 898 | Endpoint qui sert a afficher les données sur la page vie de classe 899 | 900 | __GET__ `/v3/eleves/{id}/viescolaire.awp` 901 | 902 | Data dans la réponse : 903 | ```js 904 | { 905 | "absencesRetards":[ 906 | { 907 | "id":2936, //int | Identifiant interne de l'abscence / retard 908 | "idEleve":0, //int | Normalement égal à l'id de l'eleve mais 0 dans mon cas 909 | "nomEleve":"", //string | Normalement rempli mais vide dans mon cas 910 | "typeElement":"Absence", //string | Sert pour savoir si c'est une "Abscence" ou un "Retard" 911 | "date":"2021-11-19", 912 | "displayDate":"le vendredi 19 novembre 2021 de 08:30 à 16:30", 913 | "libelle":"2 demi-journées", 914 | "motif":"", 915 | "justifie":true, //bool | Si jamais justufié ou non (note : si jamais elle est en attente de justification, elle sera a true) 916 | "par":"", 917 | "commentaire":"Merci de bien vouloir excuser l'absence de X pour la journée, il est souffrant.\nBien cordialement,", 918 | "typeJustification":" en attente de prise en compte par la vie scolaire", 919 | "justifieEd":true, // Si on peut justifier en ligne ? 920 | "aFaire":"", 921 | "dateDeroulement":"" 922 | } 923 | ], 924 | "sanctionsEncouragements":[ 925 | { 926 | "id":48, 927 | "idEleve":0, 928 | "nomEleve":"", 929 | "typeElement":"Punition", 930 | "date":"2021-11-26", 931 | "displayDate":"", 932 | "libelle":"RETENUE", 933 | "motif":"Trop de mots dans le carnet", 934 | "justifie":false, 935 | "par":"", 936 | "commentaire":"", 937 | "typeJustification":"", 938 | "justifieEd":false, 939 | "aFaire":"1 heure", 940 | "dateDeroulement":"S'est déroulé le mer. 08 décembre
de 13:00 à 14:00" 941 | } 942 | ], 943 | "parametrage": { 944 | "justificationEnLigne":true, 945 | "absenceCommentaire":true, 946 | "retardCommentaire":true, 947 | "sanctionsVisible":true, 948 | "sanctionParQui":false, 949 | "sanctionCommentaire":true, 950 | "encouragementsVisible":false, 951 | "encouragementParQui":false, 952 | "encouragementCommentaire":false 953 | } 954 | } 955 | ``` 956 | 957 | ### Carnet de correspondance 958 | 959 | Permet d'obtenir une liste des correspondances. 960 | 961 | __GET__ `/v3/eleves/{id}/eleveCarnetCorrespondance.awp` 962 | 963 | Data dans la réponse : 964 | ```jsonc 965 | { 966 | "correspondances": [ 967 | // ? 968 | ], 969 | "suivis": [ 970 | // ? 971 | ] 972 | } 973 | ``` 974 | 975 | ### Documents administratifs 976 | 977 | Permet d'obtenir la liste des documents administratifs associées à une année scolaire, ou à l'année actuelle. 978 | 979 | __GET__ `/v3/elevesDocuments.awp` 980 | 981 | Paramètres de recherche : 982 | - `archive=` pour l'année actuelle 983 | - `archive=AAAA-AAAA` pour spécifier une année précise 984 | 985 | Data dans la réponse : 986 | ```typescript 987 | { 988 | factures: [], // ? 989 | notes: Array, 990 | viescolaire: [], // ? 991 | administratifs: Array, 992 | inscriptions?: [], // ? 993 | listesPiecesAVerser: { 994 | listePieces: [], // ? 995 | personnes: Array<{id: 1234, nom: "…", prenom: "…", type: "E"}>, 996 | pieces: [], // ? 997 | televersements: [] // ? 998 | } 999 | } 1000 | ``` 1001 | 1002 | Type des objets document : 1003 | ```typescript 1004 | type Document = { 1005 | id: number, 1006 | libelle: string, 1007 | idEleve: number, 1008 | date: "AAAA-MM-JJ", 1009 | type: "Note" | "Doc" | "", 1010 | signatureDemandee: bool, // ? 1011 | signature: {} 1012 | } 1013 | ``` 1014 | 1015 | Les documents peuvent être téléchargés via la route de téléchargement grâce à leur id. 1016 | 1017 | ### Notes 1018 | 1019 | __GET__ `/v3/eleves/{id}/notes.awp` 1020 | 1021 | Les données dans la réponse sont un peu un bordel. Il y a les moyennes par période (trimestres et année), puis les notes individuelles, puis les paramètres d'affichage des notes. Ce qui veut dire que même si l'établissement désactive l'affichage de jsp quoi c'est quand même transmis, je pense (donc on peut quand même y accéder). 1022 | 1023 | Data en body : 1024 | ```typescript 1025 | { 1026 | "anneeScolaire": "", 1027 | } 1028 | ``` 1029 | 1030 | Data dans la réponse : 1031 | ```typescript 1032 | { 1033 | foStat: string, // Une sorte d'identifiant bizarre 1034 | periodes: Array<{ 1035 | idPeriode: "A001" | "A002" | "A003" | "A999Z", 1036 | codePeriode: "A001" | "A002" | "A003" | "A999Z", 1037 | periode: "1er Trimestre" | "2ème Trimestre" | "3ème Trimestre" | "Année", 1038 | annuel: bool, // false pour A001..A003, true pour A999Z 1039 | dateDebut: "AAAA-MM-JJ", 1040 | dateFin: "AAAA-MM-JJ", 1041 | examenBlanc: false, 1042 | cloture: bool, // true si la période est terminée, sinon false (cloturée) 1043 | dateConseil?: "AAAA-MM-JJ", // Présent pour les trimestres 1044 | heureConseil?: "HH:MM", 1045 | heureFinConseil?: "HH:MM", 1046 | moyNbreJoursApresConseil: 0, // moyenne du nombre de jours après le conseil, mais quels jours ? 1047 | ensembleMatieres: { 1048 | dateCalcul: "AAAA-MM-JJ HH:MM", 1049 | moyenneGenerale: "XX,YY", // C'est-à-dire une chaîne de caractère qui contient un nombre à virgule 1050 | moyenneClasse: "XX,YY", 1051 | moyenneMin: "XX,YY", 1052 | moyenneMax: "XX,YY", 1053 | nomPP: string, // Prof principal 1054 | nomCE: "", // ? 1055 | decisionDuConseil: "", // Probablement une fonctionnalité de bulletin en ligne 1056 | disciplines: Array<{ 1057 | id: number, 1058 | codeMatiere: string, 1059 | codeSousMatiere: "", 1060 | discipline: string, // = matière 1061 | moyenne: "XX,YY", 1062 | moyenneClasse: "XX,YY", 1063 | moyenneMin: "XX,YY", 1064 | moyenneMax: "XX,YY", 1065 | coef: 1, 1066 | effectif: number, // Nombre de notes dans la moyenne ? 1067 | rang: number, // Rang de l'élève dans la classe ? 1068 | groupeMatiere: false, 1069 | idGroupeMatiere: 0, 1070 | option: 0, 1071 | sousMatiere: false, 1072 | saisieAppreciationSSMAT: false, 1073 | professeurs: Array<{ id: number, nom: string }>, 1074 | }>, 1075 | disciplinesSimulation: [], 1076 | }, 1077 | }>, 1078 | notes: Array<{ 1079 | id: number, // Identifiant de la note j'imagine 1080 | devoir: string, // Nom du contrôle 1081 | codePeriode: "A001" | "A002" | "A003", 1082 | codeMatiere: string, // Nom abbrégé 1083 | libelleMatiere: string, // Nom de la matière 1084 | codeSousMatiere: "", 1085 | typeDevoir: "CONTROLE" | "INTERROGATION ORALE" | "TRAVAUX PRATIQUES" | "DEVOIR SUR TABLE" | "INTERROGATION ECRITE" | "EXERCICE" | "ENSEIGNEMENTS PRATIQUES DISCIPLINAIRES" | "DEVOIR MAISON", // Probablement pas renseigné par le professeur donc liste probablement fixe 1086 | enLettre: false, 1087 | commentaire: string, // Probablement un truc écrit par le prof 1088 | uncSujet: "", // UNC = chemin de fichier, probablement un lien vers le fichier sujet / corrigé 1089 | uncCorrige: "", 1090 | coef: "XX.YY", 1091 | noteSur: "XX,YY", 1092 | valeur: "XX,YY", // Note, enfin 1093 | nonSignificatif: bool, 1094 | date: "AAAA-MM-JJ", // Date du contrôle 1095 | dateSaisie: "AAAA-MM-JJ", // Date de l'ajout de la note, souvent les deux sont égaux (mais pas trjs) 1096 | valeurisee: false, // ? 1097 | moyenneClasse: "XX.YY", 1098 | minClasse: "XX.YY", 1099 | maxClasse: "XX.YY", 1100 | elementsProgramme: [], // Liste de compétences ou qqch du genre j'imagine 1101 | }>, 1102 | parametrage: { // Différents paramètres d'affichage, de ce qui s'affiche ou non 1103 | couleurEval1: "#FF0000", // Couleurs des compétences 1104 | couleurEval2: "#FFC000", 1105 | couleurEval3: "#0070C0", 1106 | couleurEval4: "#00B050", 1107 | libelleEval1: "Tm9uIGF0dGVpbnRz", // Non atteints (base64) 1108 | libelleEval2: "UGFydGllbGxlbWVudCBhdHRlaW50cw==", // Partiellement atteints 1109 | libelleEval3: "QXR0ZWludHM=", // Atteints 1110 | libelleEval4: "RMOpcGFzc8Opcw==", // Dépassés 1111 | affichageMoyenne: true, 1112 | affichageMoyenneDevoir: true, 1113 | affichagePositionMatiere: false, 1114 | affichageNote: true, 1115 | affichageCompetence: false, 1116 | affichageEvaluationsComposantes: false, 1117 | affichageGraphiquesComposantes: true, 1118 | modeCalculGraphiquesComposantes: "eval", 1119 | affichageCompNum: false, 1120 | libelleEvalCompNum1: "Tm9uIGF0dGVpbnQ=", // Non atteint 1121 | libelleEvalCompNum2: "UGFydGllbGxlbWVudCBhdHRlaW50", // Partiellement atteint 1122 | libelleEvalCompNum3: "QXR0ZWludA==", // Atteint 1123 | affichageAppreciation: false, 1124 | appreciationsProf: false, 1125 | appreciationProfPrinc: false, 1126 | affichageMention: false, 1127 | affichageAppreciationCE: false, 1128 | affichageAppreciationVS: false, 1129 | affichageAppreciationCN: false, 1130 | affichageAppreciationClasse: false, 1131 | affichageAppreciationPeriodeCloturee: false, 1132 | moyenneUniquementPeriodeCloture: false, 1133 | moyennePeriodeReleve: true, 1134 | moyennePeriodeAnnuelle: true, 1135 | moyennePeriodeHorsP: true, 1136 | moyenneEleveDansNotes: true, 1137 | moyenneEleve: true, 1138 | moyenneEleveDansMoyenne: true, 1139 | moyenneGenerale: true, 1140 | moyenneCoefMatiere: true, 1141 | moyenneClasse: true, 1142 | moyenneMin: true, 1143 | moyenneMax: true, 1144 | moyenneRang: false, 1145 | moyenneSur: 20, 1146 | moyenneGraphique: true, 1147 | moyennesSimulation: false, 1148 | coefficientNote: true, 1149 | colonneCoefficientMatiere: true, 1150 | noteGrasSousMoyenne: false, 1151 | noteGrasAudessusMoyenne: false, 1152 | libelleDevoir: true, 1153 | dateDevoir: true, 1154 | typeDevoir: true, 1155 | noteUniquementPeriodeCloture: false, 1156 | notePeriodeReleve: false, 1157 | notePeriodeAnnuelle: false, 1158 | notePeriodeHorsP: false, 1159 | libellesAppreciations: Array<"Appréciation générale">, 1160 | appreciationsParametrage: Array<{ 1161 | code: "APP1", 1162 | id: 1, 1163 | nbMaxCaractere: 400, 1164 | libelle: "Appréciation générale", 1165 | }>, 1166 | }, 1167 | } 1168 | ``` 1169 | 1170 | ### Espaces de travail 1171 | 1172 | __GET__ `/v3/E/{id}/espacestravail.awp` 1173 | 1174 | Liste les espaces de travail relatifs à l'élève. Voir route suivante pour le type workspace 1175 | 1176 | Data dans la réponse : 1177 | ```typescript 1178 | Array 1179 | ``` 1180 | 1181 |
1182 | 1183 | __GET__ `/v3/E/{id}/espacestravail/{espace.id}.awp` 1184 | 1185 | Data dans la réponse : 1186 | ```typescript 1187 | type Workspace = { 1188 | id: number, // Identifiant de l'espace de travail 1189 | titre: string, 1190 | description: "", // Semble toujours vide, peut-être une version plus courte de "résumé" 1191 | resume: string, // Encodé en base64 1192 | cloud: true, // Probablement si le cloud, les discussions ou l'agenda sont activés ou non 1193 | discussion: bool, 1194 | agenda: bool, 1195 | public: bool, // Si l'espace est visible par tous les élèves 1196 | ouvert: bool, // Si les élèves peuvent rejoindre l'espace librement 1197 | type: "LIBRE", 1198 | estMembre: bool, 1199 | estAdmin: false, 1200 | salleDesProfs: false, // Probablement pour l'équivalent prof des espaces de travail qui peuvent aussi servir de salle des profs numérique 1201 | creePar: string, // Nom du créateur (Prénom NOM ... NOMS) 1202 | droitUtilisateur: 0 | 1 | 2, // ? 1203 | nbMembres: 0, 1204 | couleurEvenementAgenda: "#RRVVBB", 1205 | creeLe?: "JJ/MM/AAAA à HH:MM", 1206 | } 1207 | ``` 1208 | 1209 |
1210 | 1211 | __POST__ /v3/E/{id}/espacestravail/{espace.id}/acces.awp 1212 | 1213 | Permet de joindre un espace de travail. 1214 | 1215 | Si la notation typescript ne vous est pas familière, ça veut dire qu'il faut renseigner les mêmes champs que ceux de Workspace à l'exception de `type` et `creeLe`, et aussi renseigner `cloudLibelle` et `fullLoaded`. 1216 | 1217 | TODO: Vérifier si le corps de requête est nécessaire pour joindre l'espace de travail 1218 | 1219 | Data en body : 1220 | ```typescript 1221 | Omit & { 1222 | cloudLibelle: string, // Semble être la même valeur que le `titre` de l'espace 1223 | fullLoaded: false, 1224 | } 1225 | ``` 1226 | 1227 |
1228 | 1229 | __DELETE__ /v3/E/{id}/espacestravail/{espace.id}/acces.awp 1230 | 1231 | Permet de quitter un espace de travail. 1232 | 1233 | Pas besoin d'envoyer quoi que ce soit en body; pas de réponse non plus. 1234 | 1235 | ### Manuels numériques 1236 | 1237 | __GET__ `/v3/Eleves/{id}/manuelsNumeriques.awp` 1238 | 1239 | Liste les manuels numériques disponibles pour l'élève. 1240 | 1241 | Data dans la réponse : 1242 | ```typescript 1243 | Array<{ 1244 | libelle: string, 1245 | url: string, 1246 | urlCouverture: string, 1247 | urlTelechargement: "", 1248 | editeur: string, 1249 | idRessource: string, // Je sais pas à quoi ça peut bien servir (peut-être dans l'EDT ?) 1250 | affecte: true, // ? 1251 | ogec: string, // Code RNE de l'établissement scolaire 1252 | eleves: [], // ? 1253 | disciplines: Array, // Codes des matières concernées. Vide ou 1 élément jusqu'ici 1254 | }> 1255 | ``` 1256 | 1257 | ### QCMs 1258 | 1259 | __GET__ `/v3/eleves/{id}/qcms/0/associations.awp` 1260 | 1261 | Aucune idée de ce que ça fait. Si vous avez des données, n'hésitez pas. 1262 | 1263 | ### Commandes 1264 | Il s'agit d'un système de commande (click-and-collect). 1265 | 1266 | __GET__ `/v3/menusRestaurationScolaire.awp` 1267 | 1268 | Permet de récupérer l'identifiant du menu (document). 1269 | Data dans la réponse (pour chaque semaine disponible) : 1270 | ```typescript 1271 | type Semaine = { 1272 | semaine: number, // numéro de la semaine 1273 | doc: Array<{ 1274 | libelle: string, // nom du document (Exemple: Menu semaine n°40) 1275 | id: number // numéro du document (voir téléchargement pour récupérer le document) 1276 | }> 1277 | } 1278 | ``` 1279 | 1280 | __GET__ `/v3/E/{id}/commandesPassage.awp` 1281 | 1282 | Permet de récupérer les points de passage possibles ainsi que des articles disponibles. 1283 | 1284 | Data dans la réponse : 1285 | ```typescript 1286 | { 1287 | historiqueCommandes: Array<{ 1288 | idCommande: number, //identifiant de commande 1289 | numeroCommande: string, //exemple: 010203-15 (probablement 15ème commande faite pour le 1er février 2003) 1290 | creneau: string, //exemple: "12:00 - 13:45" 1291 | date: string, 1292 | etat: string, 1293 | estHorsDelai: boolean, 1294 | idUser: number, 1295 | typeUser: string, // ELEVE 1296 | articles: Array<{ 1297 | code: string, 1298 | libelle: string, 1299 | description: string, 1300 | estFormule: boolean, 1301 | etat: number, 1302 | img: string, // (URL) 1303 | montant: number, 1304 | quantite: number, 1305 | quantiteMax: number, 1306 | estObligatoire: boolean 1307 | ordre: number, 1308 | possibilites: Array<{ 1309 | code: string, 1310 | libelle: string, 1311 | quantite: number, 1312 | etat: number, 1313 | idCateg: number, 1314 | libelleCateg: string, 1315 | ordre: number, 1316 | img: string, 1317 | choix: Array<{ 1318 | libelle: string, 1319 | id: number, 1320 | ordre: number 1321 | }>, 1322 | }>, 1323 | }>, 1324 | }>, // permet de récupérer les commandes effectuées 1325 | tabPointsDePassage: Array<{ 1326 | id: number, // identifiant du point de passage, va servir pour l'endpoint d'en dessous (idPDP) 1327 | libelle: string, // nom du point de passage 1328 | plafond: number, // ??? 1329 | nbHeureLimiteAvantCommande: number, 1330 | decouvertActif: boolean, // ??? 1331 | panierMinimum: number, // normalement que 0 1332 | categoriesArticles: Array<{ 1333 | id: number, 1334 | libelle: string, 1335 | ordre: number, 1336 | articles: Array<{ 1337 | code: string, 1338 | libelle: string, 1339 | description: string, 1340 | estFormule: boolean, 1341 | etat: number, 1342 | img: string, // (URL) 1343 | montant: number, 1344 | quantite: number, 1345 | quantiteMax: number, 1346 | estObligatoire: boolean 1347 | ordre: number, 1348 | possibilites: Array<{ 1349 | code: string, 1350 | libelle: string, 1351 | quantite: number, 1352 | etat: number, 1353 | idCateg: number, 1354 | libelleCateg: string, 1355 | ordre: number, 1356 | img: string, 1357 | choix: Array<{ 1358 | libelle: string, 1359 | id: number, 1360 | ordre: number 1361 | }>, 1362 | }>, 1363 | }>, 1364 | }>, 1365 | creneaux: Array<{ 1366 | estComplet: boolean, 1367 | libelle: string 1368 | }>, 1369 | }>, 1370 | joursFeries: Array<{{string}}>, //exemple : ["2023-01-01", "2023-02-02", etc...] 1371 | } 1372 | ``` 1373 | 1374 | __GET__ /v3/E/{id}/commandesPassage/pointsDePassage/{idPDP}/{date}.awp 1375 | 1376 | Permet de vérifier si le point de passage est possible le jour indiqué dans la requête.
Le format de la date est AAAAMMJJ. 1377 | 1378 | Data dans la réponse : 1379 | ```typescript 1380 | { 1381 | creneauMinRetrait: string, // ??? 1382 | soldePM: number, // portefeuille de l'élève 1383 | libellePM: string, // 1384 | montantDecouvert: number, //??? 1385 | montantSemaineAtteint: boolean, 1386 | montantJournalierAtteint: boolean, 1387 | nbPassageSemaineAtteint: boolean, 1388 | montantSemaine: number, 1389 | montantJournalier: number, 1390 | montantActuelSemaineUser: number, 1391 | nbPassageSemaine: number, 1392 | articlesSansStock: Array<{{string}}>, // exemple : ["DONUTS", "GAUFFRES"] 1393 | articlesAvecStock: Array<{ 1394 | id: number, 1395 | code: string 1396 | type: string, 1397 | montant: number, 1398 | idCateg: number 1399 | }> 1400 | } 1401 | ``` 1402 | 1403 | __POST__ ``/v3/E/{id}/commandesPassage.awp`` 1404 | 1405 | Permet de passer une commande. 1406 | Body: 1407 | ```typescript 1408 | { 1409 | articles: Array<{ 1410 | code: string, 1411 | libelle: string, 1412 | description: string, 1413 | estFormule: boolean, 1414 | etat: number, 1415 | img: string, // (URL) 1416 | montant: number, 1417 | quantite: number, 1418 | quantiteMax: number, 1419 | estObligatoire: boolean 1420 | ordre: number, 1421 | possibilites: Array<{ 1422 | code: string, 1423 | libelle: string, 1424 | quantite: number, 1425 | etat: number, 1426 | idCateg: number, 1427 | libelleCateg: string, 1428 | ordre: number, 1429 | img: string, 1430 | choix: Array<{ 1431 | libelle: string, 1432 | id: number, 1433 | ordre: number 1434 | }>, 1435 | }>, 1436 | }>, 1437 | creneau: string, //exemple: "12:00" 1438 | date: string, // AAAA-MM-JJ 1439 | pointDePassage: number // (idPDP) 1440 | } 1441 | ``` 1442 | En réponse, si la commande contient les bonnes informations : 1443 | ```typescript 1444 | { 1445 | idCommande: number, 1446 | numeroCommande: string, 1447 | creneau: string, 1448 | date: string, // AAAA-MM-JJ 1449 | dateCreneau: string, 1450 | etat: string, 1451 | estHorsDelai: boolean, 1452 | idUser: number, 1453 | typeUser: string, 1454 | articles: Array<{ 1455 | code: string, 1456 | libelle: string, 1457 | description: string, 1458 | estFormule: boolean, 1459 | etat: number, 1460 | img: string, // (URL) 1461 | montant: number, 1462 | quantite: number, 1463 | quantiteMax: number, 1464 | estObligatoire: boolean 1465 | ordre: number, 1466 | possibilites: Array<{ 1467 | code: string, 1468 | libelle: string, 1469 | quantite: number, 1470 | etat: number, 1471 | idCateg: number, 1472 | libelleCateg: string, 1473 | ordre: number, 1474 | img: string, 1475 | choix: Array<{ 1476 | libelle: string, 1477 | id: number, 1478 | ordre: number 1479 | }>, 1480 | }>, 1481 | }>, 1482 | pointDePassage: { 1483 | id: number, 1484 | libelle: string 1485 | } 1486 | } 1487 | ``` 1488 | Sinon, elle renvoie un code 512. 1489 | 1490 | __DELETE__ ``v3/E/{id}/commandesPassage/{idCommande}.awp``
1491 | 1492 | Permet de supprimer une commande, selon l'idCommande.
1493 | Il ne renvoie rien si l'idCommande est bon. Sinon, il renvoie simplement un code erreur 210. 1494 | 1495 | ## Classe 1496 | 1497 | ### Vie de la classe 1498 | 1499 | Il existe deux routes différentes, mais je n'ai eu que des objets vides comme réponse. 1500 | 1501 | __GET__ `/v3/Classes/{classe.id}/viedelaclasse.awp` 1502 | 1503 | __GET__ `/v3/R/{classe.id}/viedelaclasse.awp` 1504 | 1505 | 1506 | ## Cloud 1507 | 1508 | ### Chemins 1509 | 1510 | Les fichiers dans le cloud sont identifiés par leur chemin. C'est des chemins *windows*, parfois appelés `unc` dans l'API. 1511 | 1512 | On trouve différents types de chemins, avec RNE le code RNE de l'établissement : 1513 | - Les chemins des clouds élèves, du type `\{RNE}\E\{id}\...` 1514 | - Les chemins des clouds des espaces de travail, du type `\{RNE}\W\{ent.id}\...` 1515 | - Les chemins des ressources temporaires, du type `\\STOCK-TMP\tmp\{RNE}_{role}_{id}_{hash}\...` 1516 | 1517 | Parfois les chemins sont préfixés par un autre cloud, du type `\\CLOUD08\cloud\...`. Même si c'est pas pour tous les fichiers. TODO: Élucider la question. 1518 | 1519 | ### Cloud élève 1520 | 1521 | __GET__ `/v3/cloud/E/{id}.awp` 1522 | 1523 | Permet d'obtenir des informations sur un fichier ou un dossier (*nœud*) dans le cloud de l'élève. 1524 | 1525 | Lorsque des informations sur un dossier sont demandées, ses nœuds fils sont aussi transmis, y compris les sous-dossiers et leurs nœuds fils à eux aussi, jusqu'à une certaine profondeur. Après, la propriété `isLoaded` des sous-dossiers est mise sur `false` et il faut refaire une requête pour obtenir le contenu de ces sous-dossiers. 1526 | 1527 | Paramètres de recherche : 1528 | - `idfolder=` chemin de dossier, pour spécifier un dossier dont on veut obtenir le contenu. Ne pas indiquer pour obtenir la racine. 1529 | 1530 | Data dans la réponse : 1531 | ```typescript 1532 | Array 1533 | ``` 1534 | 1535 | ```typescript 1536 | type Nœud = { 1537 | type: "folder" | "file", 1538 | libelle: string, // Nom du dossier ou fichier, "/" pour la racine 1539 | date: "AAAA-MM-JJ HH:MM:SS", 1540 | taille: number, 1541 | quota?: number, 1542 | id: string, // Chemin UNC 1543 | isLoaded?: bool, // Présent pour les dossiers, voir plus haut 1544 | children?: Array, // Présent pour les dossiers 1545 | readonly: bool, 1546 | url?: string, // Pour les liens, leur URL 1547 | description?: string, // Pour les liens, leur description encodée en base64 1548 | proprietaire?: { // Présent pour les fichiers 1549 | id: number, 1550 | type: "E", 1551 | nom: string, 1552 | prenom: string, 1553 | particule: "", 1554 | } 1555 | } 1556 | ``` 1557 | 1558 |
1559 | 1560 | __POST__ `/v3/cloud/E/{id}.awp` 1561 | 1562 | Permet de créer un nouveau fichier ou dossier dans le cloud. Pour ajouter des fichiers existants, utiliser la route de téléversement. 1563 | 1564 | La route prend en body une propriété `parentNode` qui peut être un objet `Nœud` complet mais la propriété `id` est la seule nécessaire, le reste est facultatif. 1565 | 1566 | Data en body : 1567 | ```typescript 1568 | { 1569 | parentNode: Pick, 1570 | libelle: string, // Nom du nouveau nœud 1571 | typeRessource: "file" | "folder", 1572 | } 1573 | ``` 1574 | 1575 | Data dans la réponse : 1576 | ```typescript 1577 | Nœud // Nœud créé 1578 | ``` 1579 | 1580 |
1581 | 1582 | __PUT__ `/v3/cloud/E/{id}.awp` 1583 | 1584 | Permet de renommer un nœud et de changer le lien ou la description d'un lien. 1585 | 1586 | Data en body : 1587 | ```typescript 1588 | { 1589 | node: Nœud, 1590 | newLibelle: string, 1591 | newUrl?: string, 1592 | newDescription?: string, 1593 | } 1594 | ``` 1595 | 1596 | Data dans la réponse : 1597 | ```typescript 1598 | { 1599 | newId: string, 1600 | newLibelle: string, 1601 | newUrl?: string, // Présents pour les liens 1602 | newDescription?: string, 1603 | } 1604 | ``` 1605 | 1606 |
1607 | 1608 | __COPY__ `/v3/cloud/E/{id}.awp` 1609 | 1610 | Permet de copier des nœuds dans un autre dossier. 1611 | 1612 | Data en body : 1613 | ```typescript 1614 | { 1615 | parentNode: Nœud, // Dossier de destination. TODO: Vérifier spécificité (id) 1616 | clipboard: Array, // Nœuds à copier 1617 | } 1618 | ``` 1619 | 1620 | Data dans la réponse : 1621 | ```typescript 1622 | Nœud // Dossier de destination, avec les nouveaux nœuds copiés 1623 | ``` 1624 | 1625 |
1626 | 1627 | __DELETE__ `/v3/cloud/E/{id}.awp` 1628 | 1629 | Permet de supprimer un nœud. 1630 | 1631 | Data en body : 1632 | ```typescript 1633 | { 1634 | tabNodes: Array, // TODO: Vérifier si plus d'un nœud peut être spécifié 1635 | // TODO: Vérifier spécificité (id) 1636 | } 1637 | ``` 1638 | 1639 | ### Cloud espaces de travail 1640 | 1641 | Il existe une autre route pour les espaces de travail, `/v3/cloud/W/{workspace.id}.awp`. 1642 | 1643 | Il est très probable que cette route fonctionne exactement comme celle élève. 1644 | 1645 | ### Téléversement 1646 | 1647 | __POST__ `/v3/televersement.awp` 1648 | 1649 | Permet de téléverser un ficher dans le cloud ou dans le stockage temporaire pour utilisation comme pièce jointe. 1650 | 1651 | Le corps de la requête contient les fichiers téléversés au format `multipart/form-data`, ou alors des données en JSON lorsqu'on téléverse un lien dans le cloud (oui c'est possible). Notez que le serveur semble totalement ignorer le header `Content-Type` donc pas de soucis à se faire. 1652 | 1653 | Si vous tentez de téléverser un fichier dans le cloud mais qu'un fichier du même nom existe déjà, la réponse (complète) aura le code d'erreur 573 et un message descriptif 1654 | 1655 | - Pour téléverser un fichier dans le stockage temporaire, il suffit d'envoyer le fichier en corps de requête comme cité précédemment. 1656 | 1657 | Dans ce cas, data dans la réponse : 1658 | ```typescript 1659 | { 1660 | unc: string, // Chemin du fichier temporaire 1661 | libelle: string, // Nom du fichier 1662 | } 1663 | ``` 1664 | 1665 | On peut noter que le chemin est aussi présent dans la clef `message` de la réponse complète (pas limitée à `data`). 1666 | 1667 | - Pour téléverser un fichier dans le cloud, il faut en plus d'envoyer le fichier en corps, spécifier en paramètre de recherche `mode=CLOUD` et `dest={chemin}`, chemin étant le chemin du dossier dans lequel on téléverse. 1668 | 1669 | - Pour téléverser un lien dans le cloud, il suffit d'envoyer une requête avec un corps en JSON standard, qui contient : 1670 | ```typescript 1671 | { 1672 | file: "{nom}.url;{url}", // nom étant le nom du lien et url son url 1673 | description: string, // sa description encodée en base64 1674 | } 1675 | ``` 1676 | 1677 | Dans ces deux cas, data dans la réponses : 1678 | ```typescript 1679 | Nœud 1680 | ``` 1681 | 1682 | ### Téléchargement 1683 | 1684 | __GET__ `/v3/telechargement.awp` 1685 | 1686 | Permet de télécharger les fichiers dans le cloud, en pièce jointe, dans le cahier de texte et les documents administratifs. 1687 | 1688 | Data en body : 1689 | ```typescript 1690 | { 1691 | forceDownload: 0, // ? 1692 | } 1693 | ``` 1694 | 1695 | - Pour télécharger un fichier dans le cloud, il suffit d'indiquer les paramètre de recherche `leTypeDeFichier=CLOUD` et `fichierId={chemin}`, chemin étant le chemin du fichier 1696 | - Pour télécharger une pièce jointe dans le cahier de texte, il suffit d'indiquer les paramètres de recherche `leTypeDeFichier=FICHIER_CDT` et `fichierId={id}`, id étant l'identifiant de la pièce jointe 1697 | - Pour télécharger une pièce jointe à un message, il suffit d'indiquer les paramètres de recherche `leTypeDeFichier=PIECE_JOINTE`, `fichierId={id}`, id étant l'identifiant de la pièce jointe et éventuellement `anneeMessages=AAAA-AAAA` pour télécharger des pièces jointes d'anciens messages 1698 | - Pour télécharger un document administratif, il suffit d'indiquer le paramètre de recherche `fichierId={id}`, id étant l'identifiant du document, et éventuellement `archive=true` et `anneeArchive=AAAA-AAAA` pour accéder à d'anciens documents 1699 | - Pour télécharger un menu de commande click-and-collect ([ici](#commandes)), il faut ajouter `leTypeDeFichier=FICHIER_MENU_RESTAURATION`, ainsi que `fichierId={id}`, id étant le numéro du document. 1700 | 1701 | La réponse est évidemment le contenu du document directement. 1702 | -------------------------------------------------------------------------------- /docs/development/api/ed/ed.yml: -------------------------------------------------------------------------------- 1 | openapi: 3.0.0 2 | info: 3 | title: EcoleDirect API 4 | version: 3.0.0 5 | servers: 6 | - url: https://api.ecoledirecte.com 7 | tags: 8 | - name: Authentification 9 | - name: Accisition d'informations (Fetch) 10 | - name: Action 11 | 12 | components: 13 | securitySchemes: 14 | bearerAuth: # arbitrary name for the security scheme 15 | type: http 16 | scheme: bearer 17 | bearerFormat: JWT 18 | 19 | paths: 20 | /v3/login.awp: 21 | post: 22 | summary: Se connecter à son compte EcodeDirecte 23 | tags: 24 | - Authentification 25 | requestBody: 26 | required: true 27 | content: 28 | application/x-www-form-urlencoded: 29 | schema: 30 | type: object 31 | properties: 32 | data: 33 | type: string 34 | example: '{"identifiant": "string", "motdepasse": "string","isReLogin": false, "uuid": ""}' 35 | 36 | 37 | responses: 38 | '505': 39 | description: "Erreur (Mot de passe invalide)" 40 | content: 41 | application/json: 42 | schema: 43 | type: "object" 44 | properties: 45 | code: 46 | type: "integer" 47 | example: 505 48 | token: 49 | type: "string" 50 | example: "" 51 | message: 52 | type: "string" 53 | example: "Mot de passe invalide !" 54 | data: 55 | type: "object" 56 | properties: 57 | accounts: 58 | type: "array" 59 | items: {} -------------------------------------------------------------------------------- /docs/development/api/ed/papillon.md: -------------------------------------------------------------------------------- 1 | # papillon-ed-core 2 | 3 | `papillon-ed-core` est un module de base pour l'application Papillon. Il contient des classes et des fonctions qui sont utilisées pour récupérer des données, les envoyer à `IndexDataInstance` pour les afficher. 4 | 5 | ## Installation 6 | 7 | !!! npm "Node Package Manager" 8 | Le module est disponible sur [npmjs.com :octicons-link-external-24:](https://www.npmjs.com/package/papillon-ed-core){target='_blank'} sous le nom de `papillon-ed-core`. 9 | 10 | Le répo du module est disponible sur [Github :octicons-link-external-24:](https://github.com/PapillonApp/Papillon-ED-Core/){target='_blank'}. 11 | 12 | 13 | ## Documentation 14 | 15 | ### Sommaire 16 | - [Installation](#installation) 17 | - [Fonctions](#fonctions) 18 | - [auth](#auth) 19 | - [login()](#login) 20 | - [setToken()](#settoken) 21 | 22 | 23 | ### Installation 24 | ```bash 25 | npm i papillon-ed-core 26 | ``` 27 | > **Note** 28 | > Vous pouvez installer une version spécifique du module via la commande suivante : 29 | ```sh 30 | npm i papillon-ed-core@ 31 | ``` 32 | 33 | ### Fonctions 34 | 35 | #### auth 36 | L'étape suivante consiste à se connecter avec un compte EcoleDirecte existant. 37 | Pour cela, deux moyens : 38 | 39 | ##### login() 40 | **Description:**
41 | Permet de se connecter à EcoleDirecte avec des identifiants. 42 | 43 | **Paramètres:** 44 | 45 | ```javascript 46 | login("identifiant", "mot de passe") 47 | ``` 48 | 49 | **Exemple:** 50 | 51 | ```javascript 52 | const ED = require("Papillon-ED-Core") 53 | ED.auth.login("identifiant", "mot de passe").then(() => { 54 | let token = ed._token; 55 | let prenom = ed.student.prenom 56 | 57 | // ... 58 | }) 59 | .catch(err => { //en cas d'erreur à la connexion 60 | console.log(err) 61 | }) 62 | ``` 63 | 64 | ##### setToken() 65 | **Description:**
66 | 67 | Permet de se connecter à EcoleDirecte avec un token déjà généré. 68 | 69 | **Paramètres:** 70 | ```javascript 71 | setToken("token", userID) 72 | ``` 73 | 74 | **Exemple:** 75 | ```javascript 76 | const ED = require("Papillon-ED-Core") 77 | let ed = new ED() 78 | 79 | ed.auth.setToken("token", userID) 80 | 81 | //... 82 | ``` 83 | -------------------------------------------------------------------------------- /docs/development/api/papillon.md: -------------------------------------------------------------------------------- 1 | # API Papillon 2 | 3 | !!!info 4 | L'api Papillon permet de récupérer la liste des contributeurs, les disclaimers, les messages d'alerte ainsi que les informations de la dernière version de l'application. 5 | 6 | Elle est accessible à tous [ici](https://api.getpapillon.xyz) 7 | 8 | Son [repo GitHub](https://github.com/PapillonApp/PapiAPI) est public 9 | 10 | Elle est disponible sur [Docker Hub](https://hub.docker.com/repository/docker/vilerio/papillon-api/general) 11 | 12 | 13 | ## Endpoints 14 | 15 | - GET /api : Version de l'api 16 | - GET /team : Liste des membres de l'équipe 17 | - GET /messages : Liste de tous les messages de l'app 18 | - GET /latestVersion/plateforme : Dernière version de l'application pour la plateforme en question -------------------------------------------------------------------------------- /docs/development/api/pawnote.md: -------------------------------------------------------------------------------- 1 | # Pawnote (compatible avec Pronote) 2 | 3 | !!! info 4 | Pronote est une marque déposée de la société [Index Éducation :octicons-link-external-24:](https://www.index-education.com/){target='_blank'}. Papillon et Pawnote ne sont pas affiliés à Index Éducation. 5 | 6 | [Pawnote :octicons-link-external-24:](https://github.com/LiterateInk/Pawnote){target='_blank'} est un paquet Node.js qui permet d'interagir avec l'API de l'application web de gestion de vie scolaire Pronote. 7 | 8 | !!! npm "npm" 9 | Le paquet est disponible sur [npmjs.com :octicons-link-external-24:](https://www.npmjs.com/package/pawnote){target='_blank'} sous le nom `pawnote`. 10 | 11 | Développé et maintenu par [Vexcited :octicons-link-external-24:](https://github.com/Vexcited){target='_blank'}, ce module est utilisé massivement dans Papillon pour interagir avec l'API de Pronote. 12 | 13 | !!! tip "Documentation disponible" 14 | La documentation de Pawnote est disponible à l'adresse [pawnote.js.org :octicons-link-external-24:](https://pawnote.js.org){target='_blank'}. 15 | -------------------------------------------------------------------------------- /docs/development/api/ts/api.md: -------------------------------------------------------------------------------- 1 | # Turboself API 2 | 3 | !!! info 4 | Turboself est une marque déposée de la société [TurboSelf :octicons-link-external-24:](https://www.turboself.com/){target='_blank'}. Papillon n'est pas affilié à Turboself. 5 | Turboself offre un service de gestion des réservations de repas pour les cantines scolaires. 6 | 7 | Le service est accessible via une API REST. 8 | 9 | L'API a été documentée grâce aux contributions de la communauté et est accessible via Swagger. 10 | 11 | 12 | -------------------------------------------------------------------------------- /docs/development/api/ts/papillon.md: -------------------------------------------------------------------------------- 1 | ## Node.js 2 | 3 | !!! npm "Node Package Manager" 4 | Pour utiliser l'API, vous pouvez utiliser le package npm `papillon-turboself-core` disponible sur [npmjs.com :octicons-link-external-24:](https://www.npmjs.com/package/papillon-turboself-core){target='_blank'}. 5 | 6 | Le répo du module est disponible sur [Github :octicons-link-external-24:](https://github.com/PapillonApp/Papillon-Turboself-Core/){target='_blank'}. 7 | 8 | ## Documentation 9 | ### Sommaire 10 | - [Installation](#installation) 11 | - [Gestion des erreurs](#erreurs) 12 | - [Fonctions](#fonctions) 13 | - [login()](#login()) 14 | - [getUserInfo()](#getUserInfo()) 15 | - [getHome()](#getHome()) 16 | - [getBooking()](#getBooking()) 17 | - [setBooking()](#setBooking()) 18 | - [getHistory()](#getHistory()) 19 | - [getBalance()](#getBalance()) 20 | - [canBookEvening()](#canBookEvening()) 21 | - [getEtabInfo()](#getEtabInfo()) 22 | 23 | 24 | ### Installation 25 | With NPM : 26 | 27 | ```bash 28 | npm install papillon-turboself-core 29 | ``` 30 | 31 | ### Gestion des erreurs 32 | Chaque réponse retourner de ce package retourne la même forme de réponse. 33 | ```javascript 34 | { 35 | error: false, //BOOL : Y'a t'il une erreur 36 | errorMessage: '', //STRING : Raison de l'erreur (vide si il y a pas d'erreur) 37 | data: { 38 | ... 39 | } 40 | } 41 | ``` 42 | 43 | ### Fonctions 44 | 45 | ##### login() 46 | **Description:**
47 | Permet de se connecter au service MyTurboself 48 |

**Paramètres:**
49 | ```javascript 50 | login(username, password) 51 | ``` 52 | **Exemple:**
53 | ```javascript 54 | const TurboSelf = require('papillon-turboself-core') 55 | let ts = new TurboSelf(); 56 | 57 | async function main() { 58 | let result = await ts.login('username@mail.com', 'Password1234') 59 | console.log(result) 60 | } 61 | 62 | main() 63 | ``` 64 | **Retour:**
65 | ```javascript 66 | { 67 | error: false, 68 | errorMessage: '', 69 | data: { 70 | token: 'XXXXXXXXXXXX...', 71 | userId: XXXXXXX, 72 | etabId: XXXXXX 73 | } 74 | } 75 | ``` 76 | 77 | ##### getUserInfo() 78 | **Description:**
79 | Obtient les informations de l'utilisateur connecté 80 |

**Paramètres:**
81 | ```javascript 82 | getUserInfo() 83 | ``` 84 | **Exemple:**
85 | ```javascript 86 | const TurboSelf = require('papillon-turboself-core') 87 | let ts = new TurboSelf(); 88 | 89 | async function main() { 90 | await ts.login('username@mail.com', 'Password1234') 91 | let result = ts.getUserInfo() 92 | console.log(result) 93 | } 94 | 95 | main() 96 | ``` 97 | **Retour:**
98 | ```json 99 | { 100 | error: false, 101 | errorMessage: '', 102 | data: { 103 | id: XXXXXX, 104 | origId: XXXXX, 105 | type: 0, 106 | lastName: 'Doe', 107 | firstName: 'Jonh', 108 | class: 'CE1', 109 | method: 'Argent', 110 | quality: 'TICKET', 111 | authorization: { 112 | pay: true, 113 | book: true, 114 | cafeteria: false 115 | }, 116 | lastSync: '20XX-XX-XXTXX:XX:XX.XXXZ', 117 | disabled: false, 118 | isPasswordSecure: true, 119 | cardData: null 120 | } 121 | } 122 | ``` 123 | 124 | ##### getHome() 125 | **Description:**
126 | Obtient l'écran d'acceuil de l'utilisateur connecté 127 |

**Paramètres:**
128 | ```javascript 129 | getHome() 130 | ``` 131 | **Exemple:**
132 | ```json 133 | const TurboSelf = require('papillon-turboself-core') 134 | let ts = new TurboSelf(); 135 | 136 | async function main() { 137 | await ts.login('username@mail.com', 'Password1234') 138 | let result = ts.getHome() 139 | console.log(result) 140 | } 141 | 142 | main() 143 | ``` 144 | **Retour:**
145 | ```json 146 | { 147 | error: false, 148 | errorMessage: '', 149 | data: { 150 | userInfo: { 151 | id: 'XXXXXXXXXX', 152 | balance: -10.5, 153 | estimatedBalance: -150.10, 154 | estimatedFor: '20XX-XX-XX' 155 | }, 156 | history: [ 157 | { 158 | id: XXXXXXXXX, 159 | name: 'Self', 160 | date: '20XX-XX-XXTXX:XX:XX.000Z', 161 | cost: -40.8 162 | }, 163 | ... 164 | ] 165 | } 166 | } 167 | ``` 168 | 169 | ##### getBooking() 170 | **Description:**
171 | Obtient les réservations d'une semaine de l'utilisateur connecté 172 |

**Paramètres:**
173 | ```javascript 174 | getBooking(date = new Date()) 175 | ``` 176 | **Exemple:**
177 | ```json 178 | const TurboSelf = require('papillon-turboself-core') 179 | let ts = new TurboSelf(); 180 | 181 | async function main() { 182 | await ts.login('username@mail.com', 'Password1234') 183 | let result = ts.getBooking() 184 | console.log(result) 185 | } 186 | 187 | main() 188 | ``` 189 | **Retour:**
190 | ```json 191 | { 192 | error: false, 193 | errorMessage: '', 194 | data: { 195 | weekId: 'XXXXXXXXXXX', 196 | days: [ 197 | { 198 | id: 'XXXXXXXXXXX', 199 | dayNumber: 1, //(1: Lundi, 5: Vendredi) 200 | booked: true, 201 | lastSyncBooked: 1, 202 | canEdit: false, 203 | label: 'Lundi 11 Déc.', 204 | date: '11-12-2023' 205 | }, 206 | ... 207 | ] 208 | } 209 | } 210 | ``` 211 | 212 | ##### setBooking() 213 | **Description:**
214 | Défini une réservation de l'utilisateur connecté 215 |

**Paramètres:**
216 | ```javascript 217 | setBooking(weekId : Int, dayNumber : Int, booked : Bool) 218 | ``` 219 | **Exemple:**
220 | ```json 221 | const TurboSelf = require('papillon-turboself-core') 222 | let ts = new TurboSelf(); 223 | 224 | async function main() { 225 | await ts.login('username@mail.com', 'Password1234') 226 | let result = ts.setBooking(XXXXXXXXXXX, 3 (Mercredi), false) 227 | console.log(result) 228 | } 229 | 230 | main() 231 | ``` 232 | **Retour:**
233 | ```json 234 | { 235 | error: false, 236 | errorMessage: '', 237 | data: { 238 | id: 'XXXXXXXXXXX', 239 | dayNumber: 3, 240 | booked: false 241 | } 242 | } 243 | ``` 244 | 245 | ##### getHistory() 246 | **Description:**
247 | Obtient l'historique complet de l'utilisateur connecté 248 |

**Paramètres:**
249 | ```javascript 250 | getHistory() 251 | ``` 252 | **Exemple:**
253 | ```json 254 | const TurboSelf = require('papillon-turboself-core') 255 | let ts = new TurboSelf(); 256 | 257 | async function main() { 258 | await ts.login('username@mail.com', 'Password1234') 259 | let result = ts.getHistory() 260 | console.log(result) 261 | } 262 | 263 | main() 264 | ``` 265 | **Retour:**
266 | ```json 267 | { 268 | error: false, 269 | errorMessage: '', 270 | data: [ 271 | { 272 | id: XXXXXXXXX, 273 | name: 'Self', 274 | cost: -40.70, 275 | date: '20XX-XX-XXTXX:XX:XX.XXXZ' 276 | }, 277 | ... 278 | } 279 | ] 280 | } 281 | ``` 282 | 283 | #### getBalance() 284 | **Description:**
285 | Obtient le solde de l'utilisateur connecté 286 |

**Paramètres:**
287 | ```javascript 288 | getBalance() 289 | ``` 290 | **Exemple:**
291 | ```javascript 292 | const TurboSelf = require('papillon-turboself-core') 293 | let ts = new TurboSelf(); 294 | 295 | async function main() { 296 | await ts.login('username@mail.com', 'Password1234') 297 | let result = ts.getBalance() 298 | console.log(result) 299 | } 300 | 301 | main() 302 | ``` 303 | **Retour:**
304 | ```json 305 | { 306 | error: false, 307 | errorMessage: '', 308 | data: { 309 | id: 'XXXXXXXXXX', 310 | balance: 10.0, 311 | estimatedBalance: -45.13, 312 | estimatedFor: '20XX-XX-XX' 313 | } 314 | } 315 | ``` 316 | 317 | #### canBookEvening() 318 | **Description:**
319 | Retourne si l'utilisateur connecté peut réserver le soir 320 |

**Paramètres:**
321 | ```javascript 322 | canBookEvening() 323 | ``` 324 | **Exemple:**
325 | ```javascript 326 | const TurboSelf = require('papillon-turboself-core') 327 | let ts = new TurboSelf(); 328 | 329 | async function main() { 330 | await ts.login('username@mail.com', 'Password1234') 331 | let result = ts.canBookEvening() 332 | console.log(result) 333 | } 334 | 335 | main() 336 | ``` 337 | **Retour:**
338 | ```json 339 | { 340 | error: false, 341 | errorMessage: '', 342 | data: false 343 | } 344 | ``` 345 | 346 | #### getEtabInfo() 347 | **Description:**
348 | Obtient les informations de l'établissement de l'utilisateur connecté 349 |

**Paramètres:**
350 | ```javascript 351 | getEtabInfo() 352 | ``` 353 | **Exemple:**
354 | ```javascript 355 | const TurboSelf = require('papillon-turboself-core') 356 | let ts = new TurboSelf(); 357 | 358 | async function main() { 359 | await ts.login('username@mail.com', 'Password1234') 360 | let result = ts. getEtabInfo() 361 | console.log(result) 362 | } 363 | 364 | main() 365 | ``` 366 | **Retour:**
367 | ```json 368 | { 369 | error: false, 370 | errorMessage: '', 371 | data: { 372 | id: XXXX, 373 | TSid: 1, 374 | code2p5: XXXX, 375 | name: 'Lycée/Collège XXX', 376 | version: 'XXX', 377 | disabled: false, 378 | symbol: '€', 379 | minCreditAdd: 15.5, 380 | prixDej: 2.87, 381 | address: { 382 | line1: '1 Rue Doe Jonh', 383 | line2: '', 384 | postalCode: '10000', 385 | city: 'Ville connu' 386 | }, 387 | contact: { 388 | url: 'http://mon.lycee-ou-college.com/', 389 | email: 'mail@college-lycee.com', 390 | tel: '0606060606' 391 | }, 392 | sync: { 393 | first: '20XX-XX-XXTXX:XX:XX.XXXZ', 394 | last: '20XX-XX-XXTXX:XX:XX.XXXZ' 395 | } 396 | } 397 | } 398 | ``` 399 | 400 | 401 | #### getLastPayment() 402 | **Description:**
403 | Obtient le dernier paiments de l'utilisateur connecté 404 |

**Paramètres:**
405 | ```javascript 406 | getLastPayment() 407 | ``` 408 | **Exemple:**
409 | ```javascript 410 | const TurboSelf = require('papillon-turboself-core') 411 | let ts = new TurboSelf(); 412 | 413 | async function main() { 414 | await ts.login('username@mail.com', 'Password1234') 415 | let result = ts.getLastPayment() 416 | console.log(result) 417 | } 418 | 419 | main() 420 | ``` 421 | **Retour:**
422 | ```json 423 | { 424 | error: false, 425 | errorMessage:'', 426 | data: { 427 | id: 0000000, 428 | etabId: 0000000, 429 | date: '20XX-XX-XXTXX:XX:XX.XXXZ', 430 | amount: 20, 431 | method: 'CB', 432 | updateDate: '20XX-XX-XXTXX:XX:XX.XXXZ', 433 | status: 'OK', 434 | transactionId: 'XXXXXXXXXXXXXX', 435 | token: 'XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX', 436 | message: 'Paiement accepté' 437 | } 438 | } 439 | ``` -------------------------------------------------------------------------------- /docs/development/api/ts/turboself.yml: -------------------------------------------------------------------------------- 1 | openapi: 3.0.0 2 | info: 3 | title: Turboself API 4 | servers: 5 | - url: https://api-rest-prod.incb.fr 6 | tags: 7 | - name: Authentification 8 | - name: Acquisition d'informations (Fetch) 9 | - name: Action 10 | 11 | components: 12 | securitySchemes: 13 | bearerAuth: # arbitrary name for the security scheme 14 | type: http 15 | scheme: bearer 16 | bearerFormat: JWT 17 | 18 | paths: 19 | /api/v1/auth/login: 20 | post: 21 | summary: Se connecter à son compte Turbself 22 | tags: 23 | - "Authentification" 24 | requestBody: 25 | required: true 26 | content: 27 | application/json: 28 | schema: 29 | type: object 30 | properties: 31 | username: 32 | type: string 33 | password: 34 | type: string 35 | responses: 36 | '201': 37 | description: Connexion réussi 38 | content: 39 | application/json: 40 | schema: 41 | type: object 42 | properties: 43 | access_token: 44 | type: string 45 | userId: 46 | type: integer 47 | hoteId: 48 | type: integer 49 | 50 | /api/v1/etablissements: 51 | get: 52 | summary: Rechercher des établissements 53 | parameters: 54 | - name: q 55 | in: query 56 | required: true 57 | description: Nom de l'établissement à chercher 58 | schema: 59 | type: string 60 | - name: limit 61 | in: query 62 | required: true 63 | description: Limite d'établissements à afficher 64 | schema: 65 | type: integer 66 | tags: 67 | - "Accisition d'informations (Fetch)" 68 | responses: 69 | '200': 70 | description: Liste des établissements 71 | content: 72 | application/json: 73 | schema: 74 | type: array 75 | items: 76 | type: object 77 | properties: 78 | code2p5: 79 | type: integer 80 | nom: 81 | type: string 82 | versionTS: 83 | type: string 84 | 85 | /api/v1/hotes/{hoteId}: 86 | get: 87 | security: 88 | - bearerAuth: [] 89 | summary: Information sur l'établissement 90 | parameters: 91 | - name: hoteId 92 | in: path 93 | required: true 94 | description: Id de l'établissement 95 | schema: 96 | type: integer 97 | tags: 98 | - "Accisition d'informations (Fetch)" 99 | responses: 100 | '200': 101 | description: Information sur l'établissement 102 | 103 | /api/v1/hotes/{hoteId}/resa-soir: 104 | get: 105 | security: 106 | - bearerAuth: [] 107 | summary: Autorisation réservation du soir 108 | parameters: 109 | - name: hoteId 110 | in: path 111 | required: true 112 | description: Id de l'établissement 113 | schema: 114 | type: integer 115 | tags: 116 | - "Accisition d'informations (Fetch)" 117 | responses: 118 | '200': 119 | description: État autorisation réservation du soir 120 | 121 | /api/v1/reservations/hotes/{hoteId}/semaines: 122 | get: 123 | security: 124 | - bearerAuth: [] 125 | summary: Information sur les réservations 126 | parameters: 127 | - name: hoteId 128 | in: path 129 | required: true 130 | description: Id de l'établissement 131 | schema: 132 | type: integer 133 | - name: date 134 | in: query 135 | required: true 136 | description: Date format DD-MM-YYYY 137 | schema: 138 | type: string 139 | tags: 140 | - "Accisition d'informations (Fetch)" 141 | responses: 142 | '200': 143 | description: Information sur le solde 144 | 145 | /api/v2/hotes/{hoteId}/accueil: 146 | get: 147 | security: 148 | - bearerAuth: [] 149 | summary: Information sur le solde 150 | parameters: 151 | - name: hoteId 152 | in: path 153 | required: true 154 | description: Id de l'établissement 155 | schema: 156 | type: integer 157 | tags: 158 | - "Accisition d'informations (Fetch)" 159 | responses: 160 | '200': 161 | description: Information sur le solde 162 | 163 | /api/v2/hotes/{hoteId}/reservations-jours: 164 | post: 165 | security: 166 | - bearerAuth: [] 167 | tags: 168 | - "Action" 169 | summary: Réserver un repas 170 | parameters: 171 | - name: hoteId 172 | in: path 173 | required: true 174 | description: Id de l'établissement 175 | schema: 176 | type: integer 177 | requestBody: 178 | required: true 179 | content: 180 | application/json: 181 | schema: 182 | type: object 183 | properties: 184 | dayOfWeek: 185 | type: integer 186 | dayReserv: 187 | type: string 188 | web: 189 | type: object 190 | properties: 191 | id: 192 | type: integer (weekId) #week id 193 | responses: 194 | '200': 195 | description: Information sur le solde -------------------------------------------------------------------------------- /docs/development/app/android.md: -------------------------------------------------------------------------------- 1 | # Développer Papillon sous Android 2 | 3 | ## **Pré-requis** 4 | - [x] Un ordinateur sous : 5 | - Windows 8 ou ultérieur 6 | - macOS 10.14 Mojave ou ultérieur 7 | - Linux 64 bit qui prend en charge GNU C Library (glibc) en version 2.31 8 | - [x] Des bases en JavaScript 9 | - [x] Des connaissances du terminal de Windows 10 | 11 | ## **Installation des dépendances** 12 | 13 | ### Node.js 14 | [Node.js](https://nodejs.org){target=_blank} est nécessaire pour installer le reste des outils nécessaires. 15 | 16 | Vous pouvez le télécharger sur le site suivant : [https://nodejs.org](https://nodejs.org){target=_blank} 17 | 18 | ### Android Studio 19 | 20 | [Android Studio](https://developer.android.com/studio) est nécessaire pour développer sous Android. 21 | 22 | Vous pouvez le télécharger sur le site suivant : [https://developer.android.com/studio](https://developer.android.com/studio){target=_blank} 23 | 24 | !!! tip "macOS" 25 | 26 | Si vous êtes sous macOS, vous pouvez aussi installer Android Studio via [Homebrew](https://brew.sh/){target=_blank} 27 | 28 | ```sh 29 | brew install --cask android-studio 30 | ``` 31 | 32 | ## Environnement 33 | Commencez par cloner le [repo de Papillon](https://github.com/PapillonApp/Papillon){target=_blank} et mettre en place votre environnement de développement. 34 | 35 | Une fois le repo cloné, installez simplement les packages npm liés : 36 | 37 | ``` 38 | npm i 39 | ``` 40 | 41 | Il sera aussi nécessaire d'avoir [**Expo CLI**](https://docs.expo.dev/more/expo-cli/){target=_blank} : 42 | 43 | ``` 44 | npm install -g expo-cli 45 | ``` 46 | 47 | ## **Développement** 48 | 49 | Pour lancer l'application en mode développement, vous devez installer l'application de développement (un mini Expo Go qui permet de charger l'application depuis votre PC avec un live reload) 50 | 51 | Pour commencer : 52 | 53 | 1- Modifiez le fichier **`app.json`** afin de modifier le nom de l'application ainsi que son package, pour éviter de remplacer la vraie appli. 54 | 55 | - Ligne 3, variable **`name`**: remplacer par le nom de votre choix (exemple "Papillon Dev"). 56 | 57 | - Ligne 71, variable **`package`**: remplacer par exemple par **`xyz.getpapillon.app.dev`**. Ne pas changer cette variable entraînera une erreur à l'installation et un remplacement de l'appli officielle. 58 | 59 | 2- Exécutez la commande suivante dans votre terminal : 60 | ```sh 61 | npx expo prebuild 62 | ``` 63 | 64 | 3- Ouvrir Android Studio et ouvrir le dossier Android. 65 | 66 | !!! notes 67 | Si c'est la première fois que vous lancez Android Studio, de nombreux fichiers se téléchargeront automatiquement et cela prendra plus ou moins de temps en fonction de votre connexion internet. 68 | 69 | 4- Attendre que Android Studio ai terminé ses processus (visible en bas à droite). 70 | 71 | 5- Si le Gradle Sync ne s'est pas automatiquement exécuté, le faire manuellement via Files > Sync project with graddle Files ou en pressant les touches `Ctrl + Maj + O`. 72 | 73 | 6- Configurer son téléphone pour le développement : [Comment configurer son téléphone pour le développement](https://developer.android.com/studio/run/device?hl=fr#setting-up){target=_blank} 74 | 75 | Une fois que ceci est fait, vous pouvez soit : 76 | 77 | - Connecter votre téléphone à votre PC via USB : [Comment connecter son téléphone via USB](https://developer.android.com/studio/run/device?hl=fr#connect){target=_blank} 78 | - Connecter votre téléphone via wifi : [Comment connecter son téléphone via wifi](https://developer.android.com/studio/run/device?hl=fr#wireless){target=_blank} 79 | - Créer un émulateur : [Comment créer un émulateur android](https://developer.android.com/studio/run/emulator?hl=fr#avd){target=_blank} 80 | 81 | 7- Appuyer sur l'îcone "Run" en haut à droite à côté du nom de votre appareil pour démarrer le build et l'installer automatiquement sur votre appareil. 82 | 83 | !!! notes 84 | Vous pouvez consulter le statut du build en vous rendant dans l'onglet "Build" en bas du logiciel, ou dans View > Tool Window > Build. 85 | 86 | 8- Sur le PC, exécutez la commande suivante dans votre terminal : 87 | ```sh 88 | npm start 89 | ``` 90 | 91 | Si ça ne marche pas, il est possible d'exécuter la commande suivante : 92 | ```sh 93 | npx expo start --dev-client 94 | ``` 95 | 96 | 9- Lancer l'application de developpement sur le téléphone/émulateur. Le serveur doit automatiquement s'afficher en haut, cliquez dessus pour commencer le chargement.
97 | 98 | Si ce n'est pas le cas, vérifiez que : 99 | 100 | - Le wifi du PC est en mode privé (visible via les paramètres réseaux). 101 | - Le téléphone et le PC sont connectés au même réseau. Si malgré tout le serveur ne s'affiche pas, un QR Code est généré dans le terminal. Utilisez votre appareil photo pour le scanner. 102 | 103 | -------------------------------------------------------------------------------- /docs/development/app/eas.md: -------------------------------------------------------------------------------- 1 | # Développer Papillon avec 2 | 3 | !!! warning "" 4 | Ce tutoriel n'est pas complet. Il est en cours de rédaction. Si vous avez des questions, n'hésitez pas à demander sur le [Discord](https://discord.gg/ywkBZx2jFB){target=\_blank}. 5 | 6 | Il ne s'adresse pour l'instant qu'aux développeurs **Android**, mais un tutoriel pour **iOS** est en cours de rédaction. 7 | 8 | ## **Pré-requis** 9 | 10 | - [x] Un ordinateur sous : 11 | - Windows 8 ou ultérieur 12 | - macOS 10.14 Mojave ou ultérieur 13 | - Linux 64 bit qui prend en charge GNU C Library (glibc) en version 2.31 14 | - [x] Des bases en JavaScript 15 | - [x] Des connaissances du terminal de Windows 16 | - [x] Un compte Expo-EAS 17 | 18 | !!! info "Eas, c'est quoi ?" 19 | EAS ou Expo Application Services est un service cloud qui permet de construire, déployer et gérer des applications Expo ou React Native. Créé par la team derrière le framework Expo, EAS permet dans cette usage, de build une application Papillon gratuitement (même si il existe un plan payant pour des fonctionnalités avancées). Il est à utiliser notamment si vous avez peu de mémoire, de performance ou de stockage mais cela offre moins de flexibilité et de contrôle sur le build. 20 | 21 | ## **Installation des dépendances** 22 | 23 | ### Node.js 24 | 25 | [Node.js](https://nodejs.org){target=\_blank} est nécessaire pour installer le reste des outils nécessaires. 26 | 27 | Vous pouvez le télécharger sur le site suivant : [https://nodejs.org](https://nodejs.org){target=\_blank} 28 | 29 | ## Environnement 30 | 31 | Commencez par cloner le [repo de Papillon](https://github.com/PapillonApp/Papillon){target=\_blank} et mettre en place votre environnement de développement. 32 | 33 | Une fois le repo cloné, installez simplement les packages npm liés : 34 | 35 | ``` 36 | npm i 37 | ``` 38 | 39 | Il sera aussi nécessaire d'avoir [**Expo CLI**](https://docs.expo.dev/more/expo-cli/){target=\_blank} ainsi que [**EAS CLI**](https://docs.expo.dev/build/setup/){target=\_blank} : 40 | 41 | ``` 42 | npm install -g expo-cli eas-cli 43 | ``` 44 | 45 | ## **Développement** 46 | 47 | Pour lancer l'application en mode développement, vous devez installer l'application de développement (un mini Expo Go qui permet de charger l'application depuis votre PC avec un live reload) 48 | 49 | Pour commencer : 50 | 51 | 1- Se connecter à son compte EAS et à son projet 52 | 53 | Si vous ne possedez pas de compte EAS, vous pouvez en créer un en suivant ce lien : [Créer un compte EAS](https://expo.dev/signup){target=\_blank}. Ensuite reste à créer un projet EAS en vous rendant dans "Projects" puis "New project". Le nom est libre, mais le `slug` doit être **`papillonvex`**. 54 | 55 | Dans votre terminale, vous pouvez ensuite vous connecter via la commande : 56 | ```sh 57 | eas login 58 | ``` 59 | 60 | 2- Modifiez le fichier **`app.json`** afin de changer le nom de l'application ainsi que son package, pour éviter de remplacer la vraie appli, et enfin le relier à son projet EAS 61 | 62 | - Ligne 3, variable **`name`**: remplacer par le nom de votre choix (exemple "Papillon Dev"). 63 | 64 | - Ligne 71, variable **`package`**: remplacer par exemple par **`xyz.getpapillon.app.dev`**. Ne pas changer cette variable entraînera une erreur à l'installation et un remplacement de l'appli officielle. 65 | 66 | Rendez-vous sur la page de votre projet EAS, vous y trouverez deux informations utiles, l'ID et l'Owner à recopier dans le fichier **`app.json`**: 67 | 68 | - Ligne 83, variable **`projectId`** (dans `extra` puis `eas`): remplacer par l'identifiant de votre projet EAS. (champ "_ID_" sur la page EAS) 69 | 70 | - Ligne 220, variable **`owner`**: remplacer par votre nom de compte EAS. (champ "_Owner_" sur la page EAS) 71 | 72 | !!! warning "Ne pas ajouter dans un commit git ce fichier si vous l'avez modifié de la sorte !" 73 | 74 | 3- Exécutez la commande suivante dans votre terminal : 75 | 76 | ```sh 77 | npx expo prebuild 78 | ``` 79 | 80 | 4- Créer un build 81 | 82 | Pour android : 83 | 84 | ```sh 85 | eas build --profile development --platform android 86 | ``` 87 | 88 | Et pour iOS : 89 | 90 | ```sh 91 | eas build --profile development --platform ios 92 | ``` 93 | 94 | Cette commande sert à créer un build de développement, permettant d'offrir les fonctionnalités d'Expo Go. 95 | Cependant, il est possible de créer un build de "production" en remplaçant `development` par `production`. 96 | 97 | 5- Configurer son téléphone pour le développement avec une application Expo-EAS : 98 | 99 | Une fois le build terminé, vous pouvez le télécharger en se rendant sur le lien du deploiement que vous avez reçu dans votre terminal. 100 | 101 | Nous vous conseillons de vous envoyer de lien à votre téléphone, et d'y télécharger le fichier APK pour Android, ou le fichier IPA pour iOS et de l'installer. 102 | Pour installer un APK, il vous sera demandé d'activer une option dans les paramètres de votre téléphone, "Installer des applications inconnues". 103 | 104 | 6- Sur le PC, exécutez la commande suivante dans votre terminal : 105 | 106 | ```sh 107 | npm start 108 | ``` 109 | 110 | Si ça ne marche pas, il est possible d'exécuter la commande suivante : 111 | 112 | ```sh 113 | npx expo start --dev-client 114 | ``` 115 | 116 | 7- Lancer l'application de developpement sur le téléphone/émulateur. Le serveur doit automatiquement s'afficher en haut, cliquez dessus pour commencer le chargement.
117 | 118 | Si ce n'est pas le cas, vérifiez que : 119 | 120 | - Le wifi du PC est en mode privé (visible via les paramètres réseaux). 121 | - Le téléphone et le PC sont connectés au même réseau. Si malgré tout le serveur ne s'affiche pas, un QR Code est généré dans le terminal. Utilisez votre appareil photo pour le scanner. 122 | -------------------------------------------------------------------------------- /docs/development/app/ios.md: -------------------------------------------------------------------------------- 1 | # Développer Papillon sous iOS 2 | 3 | ## Pré-requis 4 | - [x] Un ordinateur sous macOS 14 ou ultérieur 5 | - [x] Des bases en JavaScript 6 | - [x] Une connaissance du terminal de macOS 7 | 8 | === "Documentation" 9 | ## Installation des dépendances 10 | ### Homebrew 11 | [Homebrew](https://brew.sh/) est nécessaire pour installer le reste des outils nécessaires. 12 | 13 | Vous pouvez l'installer simplement en indiquant cette commande dans un terminal macOS : 14 | 15 | ```sh 16 | /bin/bash -c "$(curl -fsSL https://raw.githubusercontent.com/Homebrew/install/HEAD/install.sh)" 17 | ``` 18 | 19 | ### Node & Watchman 20 | Si ce n'est pas déjà fait, installez Node.js et Watchman 21 | 22 | ```sh 23 | brew install node 24 | brew install watchman 25 | ``` 26 | ### Xcode 27 | [Xcode](https://developer.apple.com/xcode/) est nécessaire pour développer sous iOS. Installez le depuis le [Mac App Store](https://apps.apple.com/us/app/xcode/id497799835?mt=12) 28 | 29 | #### Outils de ligne de commande 30 | Vous devez aussi installer les "Command Line Tools". 31 | Ouvrez Xcode, puis dans **Préférences > Locations**, Sélectionnez la version la plus récente de Xcode dans l'onglet "Command Line Tools" 32 | ![Screenshot de Xcode](https://reactnative.dev/assets/images/GettingStartedXcodeCommandLineTools-8259be8d3ab8575bec2b71988163c850.png) 33 | 34 | ### CocoaPods 35 | Pour terminer, il est nécessaire d'avoir CocoaPods d'installé pour les dépendances de l'app. 36 | 37 | ```sh 38 | sudo gem install cocoapods 39 | ``` 40 | 41 | ## Environnement 42 | Commencez par cloner le [repo de Papillon](https://github.com/PapillonApp/Papillon) et mettre en place votre environnement de développement. 43 | 44 | Une fois le repo cloné, installez simplement les packages npm liés : 45 | 46 | ``` 47 | npm i 48 | ``` 49 | 50 | Il sera aussi nécessaire d'avoir [**Expo CLI**](https://docs.expo.dev/more/expo-cli/) : 51 | 52 | ``` 53 | npm install -g expo-cli 54 | ``` 55 | 56 | Vous devrez aussi installer les dépendances de [**Cocoapods**](https://cocoapods.org/) dans le dossier *`/ios`*: 57 | 58 | ``` 59 | pod install 60 | ``` 61 | 62 | ## Les devbuilds 63 | Pour modifier Papillon et voir vos modifications, un "devbuild" est nécessaire. 64 | 65 | C'est une version spéciale de l'app qui se connecte à votre environnement de développement pour afficher vos changements en temps réel sans avoir à recompiler Papillon. 66 | 67 | Pour commencer, modifiez le fichier **`app.json`** afin de modifier le nom de l'application ainsi que son package, pour éviter de remplacer la vraie appli. 68 | 69 | - Ligne 3, variable **`name`**: remplacer par le nom de votre choix (exemple "Papillon Dev"). 70 | 71 | - Ligne 71, variable **`package`**: remplacer par exemple par **`xyz.getpapillon.app.dev`**. Ne pas changer cette variable entraînera une erreur à l'installation et un remplacement de l'appli officielle. 72 | 73 | Pour installer une devbuild, rien de plus simple : 74 | 75 | Commencez par **prébuilder** Papillon. On expliquera en quoi cela consiste plus tard. Cette étape est nécessaire avant chaque compilation de l'app 76 | 77 | ``` 78 | npx expo prebuild 79 | ``` 80 | 81 | Une fois cela terminé, ouvrez Papillon dans Xcode en ouvrant le fichier *`/iOS/Papillon.xcworkspace`*. 82 | 83 | Vous n'avez plus qu'à démarrer l'app avec votre iPhone branché ou sur un simulateur iOS en sélectionnant un appareil et **en appuyant sur l'icône "Play" en haut de Xcode**. 84 | 85 | ### Démarrer une session de développement 86 | Une fois la prébuild installée, démarrez le serveur de développement via la commande suivante : 87 | 88 | ``` 89 | npx expo start 90 | ``` 91 | 92 | *(Vous n'êtes pas obligé de développer sur la même machine que celle qui a compilé la prébuild)* 93 | Une fois la commande démarrée, ouvrez l'app de prebuild sur votre iPhone et indiquez l'adresse du serveur ou alors, scannez le QR-Code affiché dans la console depuis l'app Appareil photo 94 | 95 | **(Vous devez avoir votre iPhone et votre ordinateur sur le même réseau local)** 96 | 97 | ## Les prébuilds 98 | La fonction ***`prebuild`*** permet de préparer l'app a être compilée en code natif pour iOS, cela indique : 99 | - Empaqueter les icônes, images, polices, et autres fichiers de l'app 100 | - Installer automatiquement les pods et modules de Papillon 101 | - Mettre a jour certaines parties natives de l'app. 102 | 103 | Tout cela se fait simplement et automatiquement avec une commande : 104 | 105 | ``` 106 | npx expo prebuild 107 | ``` 108 | 109 | Une fois effectuée, vous pouvez archiver ou démarrer l'app comme d'habitude. 110 | 111 | ## Compiler une version "release" 112 | Normalement, cela n'est pas nécessaire, mais vous pouvez créer une version release (donc indépendante) telle que vous l'obtiendrez sur l'App Store en utilisant l'option **Archive** sur Xcode. 113 | 114 | === "Tutoriel vidéo" 115 | 116 | 117 | -------------------------------------------------------------------------------- /docs/development/ent.md: -------------------------------------------------------------------------------- 1 | # Environnement de Travail Numérique 2 | 3 | ## Définition 4 | 5 | Un environnement de travail numérique est un ensemble d'outils et de services numériques utilisés pour travailler. Il peut s'agir d'outils de communication, de gestion de projet, de stockage de fichiers, de développement logiciel, etc. 6 | 7 | ## Chez Papillon 8 | ### Compatibilité 9 | 10 | Actuellement, l'application Papillon est **compatible** avec les environnements de travail numérique suivants : 11 | 12 | - Pronote 13 | - Skolengo 14 | - EcoleDirecte (en cours de développement) 15 | 16 | ### Interopérabilité 17 | 18 | Papillon est conçu pour être **interopérable** avec plusieurs environnements de travail numérique. Cela signifie que Papillon a une architecture modulaire qui permet d'ajouter facilement de nouveaux environnements de travail numérique. 19 | 20 | #### Fonctionnement 21 | 22 |

23 | 24 | ``` mermaid 25 | stateDiagram-v2 26 | 27 | skapi : Skolengo-API 28 | EcoleDirecte : Papillon-ED-Core 29 | 30 | 31 | Pawnote --> IndexDataInstance 32 | skapi --> IndexDataInstance 33 | EcoleDirecte --> IndexDataInstance 34 | ENT --> IndexDataInstance 35 | 36 | 37 | IndexDataInstance --> View 38 | View --> Utilisateur 39 | ``` 40 | 41 |
42 | 43 | Les environnements de travail numérique sont connectés à Papillon via des modules spécifiques. Ces modules permettent de récupérer les données de l'environnement de travail numérique. Ces données sont ensuite traitées par Papillon pour être affichées à l'utilisateur. 44 | 45 | !!! github "À consulter" 46 | Il est conseillé de consulter [index.ts:development :octicons-link-external-24:](https://github.com/PapillonApp/Papillon/blob/development/fetch/index.ts){target='_blank'} sur Github pour comprendre comment les données sont traitées. 47 | 48 | ### Documentation 49 | 50 | Pour chaque environnement de travail numérique, une documentation est disponible. Elle permet de comprendre comment fonctionne l'environnement de travail numérique et comment l'intégrer à Papillon. 51 | 52 | - [Pawnote (compatible avec Pronote)](api/pawnote.md) 53 | 54 | ## Mentions Légales 55 | 56 | !!! info "" 57 | Pronote est une marque déposée de la société [Index Éducation :octicons-link-external-24:](https://www.index-education.com/){target='_blank'}. Papillon et Pawnote ne sont pas affiliés à Index Éducation. 58 | 59 | !!! info "" 60 | EcoleDirecte est une marque déposée de la société [EcoleDirecte :octicons-link-external-24:](https://www.ecoledirecte.com/){target='_blank'}. Papillon n'est pas affilié à EcoleDirecte. 61 | 62 | !!! info "" 63 | Skolengo est une marque déposée de la société [Komos :octicons-link-external-24:](https://www.skolengo.com/fr/mentions-legales){target='_blank'}. Papillon n'est pas affilié à Skolengo. 64 | -------------------------------------------------------------------------------- /docs/development/intro.md: -------------------------------------------------------------------------------- 1 | # Introduction à Papillon 2 | 3 | > Papillon repose sur une architecture de développement moderne et modulaire. Il est conçu pour être facile à utiliser tout en offrant une expérience agréable aux développeurs. En tant qu'agrégateur de données scolaires, Papillon se doit de fournir une expérience développeur optimisée pour son usage. 4 | 5 | !!! note warning "Un niveau de connaissance est requis" 6 | Cette section s'adresse aux développeurs ayant un niveau de connaissance suffisant pour comprendre les concepts de base de React Native et d'Expo. 7 | 8 | ## Avant de commencer 9 | 10 | Papillon est une application basée sur React Native Expo. Il est important de suivre une certaine rigueur lors de la programmation de l'application. 11 | 12 | Voici quelques points importants à prendre en compte : 13 | 14 | 1. Utilisation de React Native Expo : Papillon est construit sur la plateforme React Native Expo, ce qui signifie que vous pouvez utiliser les fonctionnalités et les composants fournis par Expo pour développer l'application. 15 | 16 | 2. Respect des bonnes pratiques de codage : Il est essentiel de suivre les bonnes pratiques de codage lors de la programmation dans Papillon. Cela inclut l'utilisation de conventions de nommage cohérentes, l'organisation du code en modules réutilisables et la documentation appropriée. 17 | 18 | 3. Tests et débogage : Assurez-vous de tester régulièrement votre code et de le déboguer pour identifier et résoudre les erreurs. Utilisez les outils de débogage fournis par Expo pour faciliter ce processus. 19 | 20 | 4. Collaboration et gestion de version : Si vous travaillez en équipe sur le projet Papillon, il est important de suivre les bonnes pratiques de collaboration et de gestion de version. Utilisez un système de contrôle de version tel que Git pour gérer les modifications du code et faciliter la collaboration entre les membres de l'équipe. 21 | 22 | En suivant ces lignes directrices, vous pourrez développer efficacement dans l'application Papillon et garantir la qualité du code produit. 23 | 24 | ## Installer votre environnement de développement 25 | 26 | Pour commencer à développer dans l'application Papillon, vous devez d'abord configurer votre environnement de développement. Voici les étapes à suivre pour installer les outils nécessaires : 27 | 28 |
29 | 30 | 31 | iOS 32 | 33 |

iOS

34 |

35 | Ainsi que les autres plateformes Apple. Un Mac est nécessaire pour le développement Apple. 36 |

37 | 38 | 39 | 40 | android 41 | 42 |

Android

43 |

44 | Ainsi que les autres plateformes Google. Windows, macOS ou Linux est nécessaire. 45 |

46 | 47 | 48 | 49 | cloud_upload 50 | 51 |

EAS

52 |

53 | Utiliser Expo Application Services pour développer l'application dans le cloud. 54 |

55 | 56 |
57 | 58 | Une fois votre environnement de développement configuré, vous pourrez commencer à développer dans l'application Papillon en utilisant les fonctionnalités et les composants fournis par l'équipe de design et de développement. 59 | 60 | ## Soumettre des modifications 61 | 62 | Si vous souhaitez contribuer à l'application Papillon, vous pouvez consulter la [documentation pour les contributeurs](/contribute/intro) pour obtenir des informations sur la manière de soumettre des modifications, de signaler des problèmes et de participer à la communauté de développement. 63 | 64 | 65 | 189 | -------------------------------------------------------------------------------- /docs/development/pronote-api/deployment.md: -------------------------------------------------------------------------------- 1 | # Déploiement 2 | ### Pré-requis 3 | 4 | Vous devez installer **Python 3.10 minimum** et **PiP**.
5 | Ensuite installer les dépendances avec les commandes suivantes : 6 | 7 | ```sh 8 | pip3 install hug -U 9 | pip3 install pronotepy -U 10 | pip3 install lxml 11 | ``` 12 | 13 | ## Installation 14 | ### Bare-metal 15 | Une fois les pré-requis en place vous pouvez exécuter le serveur avec la commande suivante : 16 | Veuillez noter que le serveur est prévu pour fonctionner sur notre infrastructure, il est donc possible que vous deviez modifier le code pour qu'il fonctionne sur votre propre serveur. De plus, il est **nécessaire** de modifier le fichier `server.py` et de supprimer les fonctions `get_client_on_instances()` et `token_get_client()` ainsi que les appels à ces fonctions *(si présent dans la branche téléchargée)*. 17 | ```sh 18 | git clone -b main https://github.com/PapillonApp/papillon-python 19 | cd papillon-python 20 | python -m hug -f server.py 21 | ``` 22 | *Cela va lancer le serveur sur le port 8000.* 23 | 24 | ### Docker 25 | Une fois docker installé sur votre machine, vous pouvez pull l'image docker : 26 | ```sh 27 | docker pull justtryon/papillonserver:latest 28 | ``` 29 | Une fois cela fait, vous pouvez déployer l'api avec cette commande : 30 | ```sh 31 | docker run -d -p 8000:8000 -e CRON="*/15 * * * *" justtryon/papillonserver:latest 32 | ``` 33 | *Vous pouvez changer le temps de redémarrage automatique du serveur en changeant la variable d'environnement CRON* 34 | 35 | *Cela va lancer le serveur sur le port 8000.* 36 | 37 | ### Docker Swarm 38 | Le déploiement de l'api avec docker swarm va vous permettre une redondance de l'api, si un de vos serveurs n'est plus disponible, la node manager de votre cluster swarm va automatiquement prendre le relai pour que l'api soit toujours disponible, et ce sans interruption de service pour les utilisateurs.
39 | Les commandes suivantes sont à exécuter sur la node manager. 40 | ```sh 41 | docker pull justtryon/papillonserver:latest 42 | ``` 43 | Une fois cela fait, vous pouvez déployer l'api sur les différentes nodes en adaptant cette commande : 44 | 45 | ```sh 46 | docker service create \ 47 | --replicas 2 \ 48 | --constraint 'node.role==worker' \ 49 | -p 8000:8000 \ 50 | -e CRON="*/15 * * * *" \ 51 | justtryon/papillonserver:latest 52 | 53 | ``` 54 | Le paramètre "replicas" va définir le nombre de nodes sur lesquelles l'api va être déployée, vous pouvez le modifier en fonction de la taille de votre cluster.
55 | *Vous pouvez également changer le temps de redémarrage automatique du serveur en changeant la variable d'environnement CRON* 56 | 57 | *Cela va lancer le serveur sur le port 8000, en tant que service docker.* 58 | -------------------------------------------------------------------------------- /docs/development/pronote-api/endpoints.md: -------------------------------------------------------------------------------- 1 | ## Requêtes 2 | 3 | Ensuite, chaque appel à une fonction de l'API doit avoir le paramètre `token` défini. 4 | Voici la liste des URLs pour obtenir des données : 5 | 6 | | URL | Utilité | Paramètres | 7 | |--|--|--| 8 | | `/user` | Obtient les informations sur l'utilisateur (nom, classe...) + les périodes de l'année | | 9 | | `/timetable` | Affiche l'emploi du temps sur une date donnée | `dateString: str` : date au format **`année-mois-jour`** | 10 | | `/homework` | Affiche les devoirs entre deux dates données | `dateFrom: str` : date de début au format **`année-mois-jour`**, et `dateTo: str` : date de fin au même format | 11 | | `/grades` | Affiche les notes | | 12 | | `/evaluations` | Affiche les évaluations par compétences | | 13 | | `/absences` | Affiche les absences | | 14 | | `/punishments` | Affiche les punitions | | 15 | | `/news` | Affiche les actualités | | 16 | | `/discussions` | Affiche les messages | | 17 | | `/menu` | Affiche les menus entre deux dates données | `dateFrom: str` : date de début au format **`année-mois-jour`**, et `dateTo: str` : date de fin au même format | 18 | | `/recipients` | Liste toutes les personnes que l'utilisateur peut contacter par message | | 19 | 20 | Voici la liste des URLs qui effectuent une simple fonction : 21 | 22 | | URL | Utilité | Paramètres | Réponse | 23 | |--|--|--|--| 24 | | `/info` | Envoie des informations sur l'API comme les ENTs et la version | | | 25 | | `/export/ical` | Exporte le calendrier en iCal | | *(l'URL du fichier iCal)* | 26 | | `/homework/changeState` | Change l'état d'un devoir (fait/non fait) | `dateFrom: str` : date de début au format **`année-mois-jour`**, et `dateTo: str` date de fin au même format, et `homeworkId: str` l'id du devoir à changer | *(état du devoir changé)* | 27 | | `/discussion/delete` | Supprime la discussion | `discussionId: str` : Id de la discussion | `ok` si aucun problème | 28 | | `/discussion/readState` | Change l'état de lecture d'une discussion | `discussionId: str` : Id de la discussion | `ok` si aucun problème | 29 | | `/discussion/reply` | Répond à une discussion | `discussionId: str` : Id de la discussion, et `content: str` : Contenu du message | `ok` si aucun problème | 30 | | `/discussion/create` | Crée une discussion | `recipientId: str` : Id du destinataire, `content: str` : Contenu du message et `recipients: list` : La liste de destinataire avec leurs ID (obtenus avec `/recipients`) | `ok` si aucun problème | 31 | -------------------------------------------------------------------------------- /docs/development/pronote-api/index.md: -------------------------------------------------------------------------------- 1 | # Introduction 2 | 3 | Papillon utilise actuellement un serveur intermédiaire, dont l'API facilite l'accès indirect à l'API privée d'un serveur PRONOTE.net. 4 | 5 | Cette section documente cette première API. Pour consulter la documentation de l'API privée PRONOTE.net, veuillez vous référer à [PRONOTE protocol](https://github.com/bain3/pronotepy/blob/master/PRONOTE%20protocol.md) du projet pronotepy. 6 | -------------------------------------------------------------------------------- /docs/development/pronote-api/login.md: -------------------------------------------------------------------------------- 1 | Un client doit effectuer la requête initiale `POST /generatetoken` avec le corps de la requête suivant : 2 | 3 | | Paramètre | Utilité | Exemple | 4 | |--|--|--| 5 | | `url: str(url)` | URL vers l'instance PRONOTE **(avec le eleve.html)** | `https://0152054e.index-education.net/pronote/eleve.html` | 6 | | `username: str` | Nom d'utilisateur **PRONOTE** | `l.martin` | 7 | | `password: str` | Mot de passe en clair | `azertyuiop12345` | 8 | | `ent: str(ent)` | Nom de l'ENT tel que listé [ici](https://github.com/bain3/pronotepy/blob/master/pronotepy/ent/ent.py) | `ac_rennes` | 9 | 10 | Le client doit ensuite conserver le token généré. S'il y a eu un délai d'au moins 5 minutes entre deux interactions, le client doit regénérer un nouveau token. 11 | -------------------------------------------------------------------------------- /docs/documents/privacy-policy.md: -------------------------------------------------------------------------------- 1 | # Politique de confidentialité 2 | > Ce service peut être amené à collecter certaines données personnelles de ses utilisateurs. 3 | 4 | ## 1. - Services concernés 5 | - Site web de présentation ([https://getpapillon.xyz](https://getpapillon.xyz)) 6 | - Application mobile Papillon ([https://github.com/PapillonApp/Papillon](https://github.com/PapillonApp/Papillon)) 7 | 8 | ## 2. - Quelles données sont collectées ? 9 | ### 2.1 - Données collectées 10 | - #### Vos données d’identification à votre service scolaire 11 | > Identifiants de connexion au service scolaire, URL de l'établissement et académie correspondante *(le cas échéant)* 12 | 13 | Ces données d'identification ne sont pas stockées en dehors de votre appareil et sont utilisées uniquement pour vous identifier. 14 | 15 | - #### Vos données scolaires 16 | > Emploi du temps, Travail à faire, Notes, Compétences, Actualités de l'établissement, Conversations et Événements de vie scolaire 17 | 18 | Ces données sont renvoyées par les services de vie scolaire correspondants. Ces données ne quitteront jamais votre appareil et seuls vous y avez accès. 19 | 20 | ### 2.1.1 Logs et crash reports 21 | Les derniers événements précédant un crash peuvent être automatiquement collectés a des fins de développement. 22 | > Ces données contiennent des informations sur votre appareil et sur l'état de l'application. 23 | 24 | Aucune information personnelle ou scolaire n'est transmise pendant cette collecte. 25 | 26 | ### 2.2 - Données liées à l'identité 27 | Aucune donnée liée à votre identité ou à votre activité n'est conservée, hormis les logs récents à des fins de développement pour corriger d'éventuels bugs et problèmes. 28 | 29 | ### 2.3 - Accès extérieur aux données 30 | Aucune personne ou logiciel automatisé n’utilise ou ne collecte vos données personnelles. 31 | 32 | ### 2.4 - Suppression des données 33 | La suppression de l'application ou la déconnexion entraîne immédiatement la suppression de l'intégralité des données stockées sur votre appareil. 34 | 35 | ## 3. - Client mobile Papillon 36 | L'application "Papillon" est un logiciel open source, gratuit et à but non lucratif conçu pour permettre l'accès aux données des services scolaires transmises par des librairies tierces. 37 | 38 | Papillon n'est pas responsable de la manière dont les données sont transmises par ces librairies tierces. 39 | 40 | ## 4. - Modification de la politique de confidentialité 41 | 42 | ### 4.1 - Engagement concernant l'avenir du projet 43 | Nous nous engageons à ne pas collecter de données à l'avenir. Cependant, des services tiers supplémentaires seront peut-être nécessaires au fonctionnement de l'application dans une prochaine mise à jour. 44 | 45 | ### 4.2 - Notification des changements 46 | Lorsque cette politique de confidentialité sera modifiée, les utilisateurs finaux seront notifiés soit via l'application, soit via leurs coordonnées (dans le cas d'une bêta-test, ou sur une communauté en ligne, par exemple). 47 | 48 | ## 5. - En cas de problème 49 | En cas de problème avec l'application ou son traitement des données, merci de nous contacter à l'adresse suivante : [support@getpapillon.xyz](mailto:support@getpapillon.xyz). 50 | -------------------------------------------------------------------------------- /docs/documents/terms-of-service.md: -------------------------------------------------------------------------------- 1 | # Conditions générales d'utilisation 2 | 3 | ## 1. - Services concernés 4 | - Site web de présentation ([https://getpapillon.xyz](https://getpapillon.xyz)) 5 | - Application mobile Papillon ([https://github.com/PapillonApp/Papillon](https://github.com/PapillonApp/Papillon)) 6 | 7 | ## 2. - Conditions 8 | En tant qu'utilisateur final, vous acceptez et comprenez que : 9 | 10 | - Papillon est un client alternatif non officiel. 11 | - Papillon n'est affilié à aucune entreprise ou organisation. 12 | - Vos données ne quittent pas votre appareil conformément à la [:material-gavel: politique de confidentialité](privacy-policy.md). 13 | - Papillon peut être modifié ou retiré de la vente à tout moment par le gestionnaire du service. 14 | 15 | ## 3. - En cas de problème 16 | En cas de problème avec l'application ou son traitement des données, merci de nous contacter à l'adresse suivante : [support@getpapillon.xyz](mailto:support@getpapillon.xyz). 17 | -------------------------------------------------------------------------------- /docs/events/la-meilleure-icone-papillon.md: -------------------------------------------------------------------------------- 1 | # Concours de création d'icônes Papillon 2 | 3 | ![image](https://github.com/PapillonApp/docs/assets/32978709/6652aaf3-0ae6-4151-8c55-8a5f5d4f71f6) 4 | 5 | Pour fêter la rentrée, Papillon organise un concours de la communauté pour mettre en valeur **vos talents d'artiste** ! 6 | 7 | À vos crayons pour créer la meilleure icône Papillon et espérer la voir disponible dans l'application ! 8 | 9 | Cependant, pour participer, suivez ces instructions et respectez ces règles : 10 | 11 | ## Instructions 12 | 13 | ### Les interdits 14 | - Il est interdit d'utiliser des images ou des vecteurs **non libres de droit ou sous licence**. 15 | - Aucun contenu qui serait interdit de publication sur les stores (dessins ou images choquantes, discriminatoires, ou susceptible de heurter la sensibilité de certaines personnes). 16 | 17 | ### Les obligations 18 | - Faites apparaître le logo de Papillon de manière **assez visible et claire**. 19 | 20 | ### Les recommandations 21 | - Placez le logo de manière similaire, voire identique à l'icône de base. 22 | - Modifiez le fond du logo pour en changer les couleurs, ajouter des éléments, images, et autres. 23 | - Modifiez le papillon afin de changer son aspect. 24 | 25 | ### Le rendu 26 | - L'image doit être au format JPEG ou PNG à une résolution minimale de `1024px * 1024px` et au format `1:1` (carré). 27 | - Aucune image transparente. 28 | - Aucune image animée. 29 | - Utilisez une image carrée pleine (pas de format cercle, triangle, ou autre forme). 30 | 31 | ## Ressources 32 | 33 | Afin de vous simplifier la tâche, vous pouvez télécharger l'icône de base de Papillon ici, elle peut vous être utile comme base : 34 | - Format SVG (pour Figma et Illustrator) : [icon.svg](https://logi12-my.sharepoint.com/:u:/g/personal/contact_vincelinise_com/EQ-1wyA167NKvHiAAQSUdegBT5dix-zp0ePF144hdvyIjA?e=EGct3B) 35 | - Format PNG (tous logiciels) : [icon.png](https://logi12-my.sharepoint.com/:i:/g/personal/contact_vincelinise_com/EXZOKAKDT5ZBu-Fx0WT34LEBssUsIbRBe6mt6VZEy8e-sA?e=rgAyEX) 36 | 37 | **Note :** Le téléchargement des ressources nécessite l'accès à des liens externes. 38 | 39 | Si vous ne pouvez pas manipuler d'images SVG, voici le logo Papillon en blanc uni au format PNG transparent : [Union.png](https://logi12-my.sharepoint.com/:i:/g/personal/contact_vincelinise_com/EVoz8rVfV_ZFiAWQwzn5szUBlZYpxnZnknTjRbxs1VUWGw?e=LtdnRt) 40 | -------------------------------------------------------------------------------- /docs/help/index.md: -------------------------------------------------------------------------------- 1 | # Aide de Papillon 2 | 3 | ## Documentation en construction 4 | La documentation est en construction, revenez plus tard ! -------------------------------------------------------------------------------- /docs/index.md: -------------------------------------------------------------------------------- 1 |
2 | 6 |
7 |

8 | Documentation technique de Papillon 9 |

10 |

11 | et des services associés. 12 |

13 |
14 |
15 | 16 | !!! note warning "Documentation pour les développeurs et designers" 17 | Cette documentation est destinée aux développeurs et designers qui souhaitent contribuer à Papillon. 18 | Pour les utilisateurs, veuillez vous référer à la [documentation utilisateur](https://support.getpapillon.xyz/). 19 | 20 |
21 | 22 | 23 | palette 24 | 25 |

Designer

26 |

27 | Créez des maquettes, des prototypes et des designs pour Papillon. Vous pouvez contribuer à la charte graphique. 28 |

29 | 30 | 31 | 32 | code 33 | 34 |

Développer

35 |

36 | Modifier le code source de Papillon pour ajouter des fonctionnalités, en améliorer certaines, ou corriger des bugs. 37 |

38 | 39 | 40 | 41 | group 42 | 43 |

Contribuer

44 |

45 | Contribuer à la documentation, à la communication et à la recherche de bugs de Papillon. 46 |

47 | 48 |
49 | 50 | ### Mentions légales 51 | 52 |
53 | 54 | 55 | gavel 56 | 57 |

Politique de confidentialité

58 |

59 | Consultez notre politique de confidentialité pour en savoir plus sur la collecte et l'utilisation de vos données. 60 |

61 | 62 | 63 | 64 | assignment 65 | 66 |

Conditions d'utilisation

67 |

68 | Consultez nos conditions d'utilisation pour en savoir plus sur les règles d'utilisation de nos services. 69 |

70 | 71 |
72 | 73 | ### Bêta de Papillon 74 | Une bêta de Papillon est disponible pour les utilisateurs qui souhaitent tester les nouvelles fonctionnalités. 75 | 76 | [:octicons-arrow-right-24: Rejoindre la bêta de Papillon](contribute/beta) 77 | 78 | -------------------------------------------------------------------------------- /docs/index_old.md: -------------------------------------------------------------------------------- 1 | # 2 | 3 |
4 | ![Papillon](assets/beta.png){ width="300px" } 5 | 6 | # Documentation technique de Papillon et des services associés. 7 | 8 |
9 | 10 | 11 | !!! note warning "Documentation pour les développeurs et designers" 12 | Cette documentation est destinée aux développeurs et designers qui souhaitent contribuer à Papillon. 13 | Pour les utilisateurs, veuillez vous référer à la [documentation utilisateur](https://support.getpapillon.xyz/). 14 | 15 | !!! note warning "Documentation en construction" 16 | La documentation est en construction, revenez plus tard si quelque chose n'est pas disponible ! 17 | 18 |
19 | 20 | - :octicons-typography-24:{ .lg .middle } __Designer__ 21 | 22 | --- 23 | 24 | Créez des maquettes, des prototypes et des designs pour Papillon. Vous pouvez contribuer à la charte graphique. 25 | 26 | [:octicons-arrow-right-24: Consulter](design/intro.md) 27 | 28 | - :octicons-file-code-24:{ .lg .middle } __Développer__ 29 | 30 | --- 31 | 32 | Modifier le code source de Papillon pour ajouter des fonctionnalités ou corriger des bugs. 33 | 34 | [:octicons-arrow-right-24: Consulter](develop/intro.md) 35 | 36 | - :octicons-code-of-conduct-24:{ .lg .middle } __Contribuer__ 37 | 38 | --- 39 | 40 | Contribuer à la documentation, à la traduction, à la communication, à la recherche de bugs de Papillon. 41 | 42 | [:octicons-arrow-right-24: Consulter](contribute/intro.md) 43 | 44 | - :material-apps:{ .lg .middle } __Rejoindre la bêta__ 45 | 46 | --- 47 | 48 | Une bêta de Papillon est disponible pour les utilisateurs qui souhaitent tester les nouvelles fonctionnalités. 49 | 50 | [:octicons-arrow-right-24: Rejoindre la bêta de Papillon](contribute/beta) 51 | 52 |
53 | 54 | ## Nos réseaux sociaux 55 | 56 |
57 | 58 | - :fontawesome-brands-discord: [discord.gg/__ywkBZx2jFB__](https://discord.gg/ywkBZx2jFB){target=_blank} 59 | - :fontawesome-brands-github-alt: [github.com/__PapallonApp__](https://github.com/PapallonApp){target=_blank} 60 | - :fontawesome-brands-x-twitter: [twitter.com/__thepapillonapp__](https://twitter.com/thepapillonapp){target=_blank} 61 | - :fontawesome-brands-instagram: [instragram.com/__thepapillonapp__](https://instagram.com/thepapillonapp){target=_blank} 62 | 63 |
64 | 65 | ## Mentions légales 66 | - [:material-gavel: Politique de confidentialité](documents/privacy-policy) 67 | - [:material-gavel: Conditions générales d'utilisation](documents/terms-of-service) 68 | 69 | !!! note "" 70 | Papillon n'est affilié à aucune entreprise ou organisation. Papillon est un projet open-source et communautaire. 71 | -------------------------------------------------------------------------------- /docs/stylesheets/extra.css: -------------------------------------------------------------------------------- 1 | :root { 2 | --md-admonition-icon--discord: url('data:image/svg+xml;charset=utf-8,'); 3 | --md-admonition-icon--github: url('data:image/svg+xml;charset=utf-8,'); 4 | --md-admonition-icon--npm: url('data:image/svg+xml;charset=utf-8,'); 5 | } 6 | 7 | .md-typeset .admonition.discord, 8 | .md-typeset details.discord { 9 | border-color: rgb(88, 101, 242); 10 | } 11 | .md-typeset .discord > .admonition-title, 12 | .md-typeset .discord > summary { 13 | background-color: rgba(88, 101, 242, 0.1); 14 | } 15 | .md-typeset .discord > .admonition-title::before, 16 | .md-typeset .discord > summary::before { 17 | background-color: rgb(88, 101, 242); 18 | -webkit-mask-image: var(--md-admonition-icon--discord); 19 | mask-image: var(--md-admonition-icon--discord); 20 | } 21 | 22 | .md-typeset .admonition.github, 23 | .md-typeset details.github { 24 | border-color: rgb(110, 84, 148); 25 | } 26 | .md-typeset .github > .admonition-title, 27 | .md-typeset .github > summary { 28 | background-color: rgba(110, 84, 148, 0.1); 29 | } 30 | .md-typeset .github > .admonition-title::before, 31 | .md-typeset .github > summary::before { 32 | background-color: rgb(110, 84, 148); 33 | -webkit-mask-image: var(--md-admonition-icon--github); 34 | mask-image: var(--md-admonition-icon--github); 35 | } 36 | 37 | .md-typeset .admonition.npm, 38 | .md-typeset details.npm { 39 | border-color: rgb(204, 53, 52); 40 | } 41 | .md-typeset .npm > .admonition-title, 42 | .md-typeset .npm > summary { 43 | background-color: rgba(204, 53, 52, 0.1); 44 | } 45 | .md-typeset .npm > .admonition-title::before, 46 | .md-typeset .npm > summary::before { 47 | background-color: rgb(204, 53, 52); 48 | -webkit-mask-image: var(--md-admonition-icon--npm); 49 | mask-image: var(--md-admonition-icon--npm); 50 | } -------------------------------------------------------------------------------- /mkdocs.yml: -------------------------------------------------------------------------------- 1 | site_name: Documentation technique Papillon 2 | site_url: https://docs.getpapillon.xyz 3 | repo_url: https://github.com/PapillonApp/docs 4 | repo_name: PapillonApp/docs 5 | edit_uri: edit/main/docs/ 6 | nav: 7 | - Accueil: 'index.md' 8 | - Designer : 9 | - Introduction : 'design/intro.md' 10 | - Charte Graphique : 11 | - Couleurs : 'design/color.md' 12 | - Polices d'écriture : 'design/font.md' 13 | - Ressources externe : 14 | - Charte grapique (PDF) : '../assets/design/Charte%20Graphique%20-%20Papillon%20(sept.%202023).pdf' 15 | - Figma (Public) : 'https://www.figma.com/file/EZ9HbmMmCywyCxp3OuvofF/Product-design-Papillon?type=design&node-id=316%3A470&mode=design&t=gEZXuZLlWRlCkLNn-1' 16 | - Développer : 17 | - Introduction : 'development/intro.md' 18 | - Fonctionnement de l'app : 19 | - ENT : 'development/ent.md' 20 | - Environement de développement : 21 | - Développement iOS : 'development/app/ios.md' 22 | - Développement Android : 'development/app/android.md' 23 | - Développement via EAS : 'development/app/eas.md' 24 | - API utilisées pour Papillon : 25 | - Pawnote (compatible Pronote) : 'development/api/pawnote.md' 26 | - EcoleDirecte: 27 | - API: 'development/api/ed/api.md' 28 | - papillon-ed-core: 'development/api/ed/papillon.md' 29 | - Turboself: 30 | - API : 'development/api/ts/api.md' 31 | - papillon-turboself-core : 'development/api/ts/papillon.md' 32 | - API Papillon: 'development/api/papillon.md' 33 | - Contribuer : 34 | - Introduction : 'contribute/intro.md' 35 | - Tester les nouveautés : 36 | - Programme bêta : 'contribute/beta.md' 37 | - Rapporter des problèmes : 'contribute/reporting-issues.md' 38 | - Soumettre vos modifications : 39 | - Pull Request : 'contribute/pull-request.md' 40 | - Parution dans l'app finale : 'contribute/final-step.md' 41 | theme: 42 | name: material 43 | palette: 44 | # Palette toggle for light mode 45 | - media: "(prefers-color-scheme: light)" 46 | scheme: default 47 | primary: teal 48 | accent: teal 49 | toggle: 50 | icon: material/brightness-7 51 | name: Switch to dark mode 52 | # Palette toggle for dark mode 53 | - media: "(prefers-color-scheme: dark)" 54 | scheme: slate 55 | primary: teal 56 | accent: teal 57 | toggle: 58 | icon: material/brightness-4 59 | name: Switch to system preference 60 | language: fr 61 | logo: assets/beta.png 62 | favicon: assets/beta.png 63 | font: 64 | text: Noto Sans 65 | features: 66 | - navigation.instant 67 | - navigation.instant.progress 68 | - navigation.tabs 69 | - navigation.footer 70 | - content.action.edit 71 | - content.code.copy 72 | - content.code.select 73 | - content.code.annotate 74 | - navigation.sections 75 | plugins: 76 | - search 77 | - swagger-ui-tag 78 | - git-revision-date-localized: 79 | locale: fr 80 | type: timeago 81 | fallback_to_build_date: true 82 | extra: 83 | social: 84 | - icon: fontawesome/brands/github 85 | link: https://github.com/PapillonApp/Papillon 86 | - icon: fontawesome/brands/instagram 87 | link: https://www.instagram.com/thepapillonapp/ 88 | - icon: fontawesome/brands/discord 89 | link: https://discord.gg/ywkBZx2jFB/ 90 | markdown_extensions: 91 | - pymdownx.highlight: 92 | anchor_linenums: true 93 | line_spans: __span 94 | pygments_lang_class: true 95 | - pymdownx.superfences: 96 | custom_fences: 97 | - name: mermaid 98 | class: mermaid 99 | format: !!python/name:pymdownx.superfences.fence_code_format 100 | - pymdownx.inlinehilite 101 | - pymdownx.snippets 102 | - pymdownx.superfences 103 | - admonition 104 | - pymdownx.details 105 | - footnotes 106 | - pymdownx.tabbed: 107 | alternate_style: true 108 | - attr_list 109 | - md_in_html 110 | - def_list 111 | - pymdownx.tasklist: 112 | custom_checkbox: true 113 | - abbr 114 | - pymdownx.emoji: 115 | emoji_index: !!python/name:material.extensions.emoji.twemoji 116 | emoji_generator: !!python/name:material.extensions.emoji.to_svg 117 | - pymdownx.critic 118 | - pymdownx.caret 119 | - pymdownx.keys 120 | - pymdownx.mark 121 | - pymdownx.tilde 122 | extra_css: 123 | - stylesheets/extra.css 124 | -------------------------------------------------------------------------------- /netlify.toml: -------------------------------------------------------------------------------- 1 | # netlify.toml 2 | [build] 3 | command = "mkdocs build" 4 | publish = "site" -------------------------------------------------------------------------------- /requirements.txt: -------------------------------------------------------------------------------- 1 | mkdocs-material>=9.2.0b2 2 | mkdocs-git-committers-plugin-2>=1.1.2 3 | mkdocs-git-revision-date-localized-plugin>=1.2.0 4 | mkdocs-swagger-ui-tag>=0.6.8 -------------------------------------------------------------------------------- /runtime.txt: -------------------------------------------------------------------------------- 1 | 3.8 --------------------------------------------------------------------------------