Skip to content

Commit 7295722

Browse files
committed
docs: readme
1 parent 2ad769b commit 7295722

5 files changed

Lines changed: 152 additions & 97 deletions

File tree

.github/workflows/codeql.yml

Lines changed: 54 additions & 29 deletions
Original file line numberDiff line numberDiff line change
@@ -9,68 +9,93 @@
99
# the `language` matrix defined below to confirm you have the correct set of
1010
# supported CodeQL languages.
1111
#
12-
name: "CodeQL"
12+
name: "CodeQL Advanced"
1313

1414
on:
1515
push:
1616
branches: [ "main" ]
1717
pull_request:
18-
# The branches below must be a subset of the branches above
1918
branches: [ "main" ]
2019
schedule:
21-
- cron: '26 22 * * 5'
20+
- cron: '42 10 * * 2'
2221

2322
jobs:
2423
analyze:
25-
name: Analyze
26-
runs-on: ubuntu-latest
24+
name: Analyze (${{ matrix.language }})
25+
# Runner size impacts CodeQL analysis time. To learn more, please see:
26+
# - https://gh.io/recommended-hardware-resources-for-running-codeql
27+
# - https://gh.io/supported-runners-and-hardware-resources
28+
# - https://gh.io/using-larger-runners (GitHub.com only)
29+
# Consider using larger runners or machines with greater resources for possible analysis time improvements.
30+
runs-on: ${{ (matrix.language == 'swift' && 'macos-latest') || 'ubuntu-latest' }}
2731
permissions:
32+
# required for all workflows
33+
security-events: write
34+
35+
# required to fetch internal or private CodeQL packs
36+
packages: read
37+
38+
# only required for workflows in private repositories
2839
actions: read
2940
contents: read
30-
security-events: write
3141

3242
strategy:
3343
fail-fast: false
3444
matrix:
35-
language: [ 'javascript' ]
36-
# CodeQL supports [ 'cpp', 'csharp', 'go', 'java', 'javascript', 'python', 'ruby' ]
37-
# Use only 'java' to analyze code written in Java, Kotlin or both
38-
# Use only 'javascript' to analyze code written in JavaScript, TypeScript or both
39-
# Learn more about CodeQL language support at https://aka.ms/codeql-docs/language-support
40-
45+
include:
46+
- language: actions
47+
build-mode: none
48+
- language: javascript-typescript
49+
build-mode: none
50+
# CodeQL supports the following values keywords for 'language': 'actions', 'c-cpp', 'csharp', 'go', 'java-kotlin', 'javascript-typescript', 'python', 'ruby', 'rust', 'swift'
51+
# Use `c-cpp` to analyze code written in C, C++ or both
52+
# Use 'java-kotlin' to analyze code written in Java, Kotlin or both
53+
# Use 'javascript-typescript' to analyze code written in JavaScript, TypeScript or both
54+
# To learn more about changing the languages that are analyzed or customizing the build mode for your analysis,
55+
# see https://docs.github.com/en/code-security/code-scanning/creating-an-advanced-setup-for-code-scanning/customizing-your-advanced-setup-for-code-scanning.
56+
# If you are analyzing a compiled language, you can modify the 'build-mode' for that language to customize how
57+
# your codebase is analyzed, see https://docs.github.com/en/code-security/code-scanning/creating-an-advanced-setup-for-code-scanning/codeql-code-scanning-for-compiled-languages
4158
steps:
4259
- name: Checkout repository
43-
uses: actions/checkout@v3
60+
uses: actions/checkout@v4
61+
62+
# Add any setup steps before running the `github/codeql-action/init` action.
63+
# This includes steps like installing compilers or runtimes (`actions/setup-node`
64+
# or others). This is typically only required for manual builds.
65+
# - name: Setup runtime (example)
66+
# uses: actions/setup-example@v1
4467

4568
# Initializes the CodeQL tools for scanning.
4669
- name: Initialize CodeQL
47-
uses: github/codeql-action/init@v2
70+
uses: github/codeql-action/init@v4
4871
with:
4972
languages: ${{ matrix.language }}
73+
build-mode: ${{ matrix.build-mode }}
5074
# If you wish to specify custom queries, you can do so here or in a config file.
5175
# By default, queries listed here will override any specified in a config file.
5276
# Prefix the list here with "+" to use these queries and those in the config file.
5377

54-
# Details on CodeQL's query packs refer to : https://docs.github.com/en/code-security/code-scanning/automatically-scanning-your-code-for-vulnerabilities-and-errors/configuring-code-scanning#using-queries-in-ql-packs
78+
# For more details on CodeQL's query packs, refer to: https://docs.github.com/en/code-security/code-scanning/automatically-scanning-your-code-for-vulnerabilities-and-errors/configuring-code-scanning#using-queries-in-ql-packs
5579
# queries: security-extended,security-and-quality
5680

57-
58-
# Autobuild attempts to build any compiled languages (C/C++, C#, Go, or Java).
59-
# If this step fails, then you should remove it and run the build manually (see below)
60-
- name: Autobuild
61-
uses: github/codeql-action/autobuild@v2
62-
81+
# If the analyze step fails for one of the languages you are analyzing with
82+
# "We were unable to automatically build your code", modify the matrix above
83+
# to set the build mode to "manual" for that language. Then modify this step
84+
# to build your code.
6385
# ℹ️ Command-line programs to run using the OS shell.
6486
# 📚 See https://docs.github.com/en/actions/using-workflows/workflow-syntax-for-github-actions#jobsjob_idstepsrun
65-
66-
# If the Autobuild fails above, remove it and uncomment the following three lines.
67-
# modify them (or add more) to build your code if your project, please refer to the EXAMPLE below for guidance.
68-
69-
# - run: |
70-
# echo "Run, Build Application using script"
71-
# ./location_of_script_within_repo/buildscript.sh
87+
- name: Run manual build steps
88+
if: matrix.build-mode == 'manual'
89+
shell: bash
90+
run: |
91+
echo 'If you are using a "manual" build mode for one or more of the' \
92+
'languages you are analyzing, replace this with the commands to build' \
93+
'your code, for example:'
94+
echo ' make bootstrap'
95+
echo ' make release'
96+
exit 1
7297
7398
- name: Perform CodeQL Analysis
74-
uses: github/codeql-action/analyze@v2
99+
uses: github/codeql-action/analyze@v4
75100
with:
76101
category: "/language:${{matrix.language}}"

README.md

Lines changed: 96 additions & 29 deletions
Original file line numberDiff line numberDiff line change
@@ -1,50 +1,117 @@
1-
# Welcome to your Expo app 👋
1+
<p align="center">
2+
<img alt="UniceNotes" height="200" src="https://raw.githubusercontent.com/UniceApps/UniceNotes/main/.docs/assets/logo.png">
3+
<h2 align="center">UniceNotes</h2>
24

3-
This is an [Expo](https://expo.dev) project created with [`create-expo-app`](https://www.npmjs.com/package/create-expo-app).
5+
<p align="center">
6+
<b>UniceNotes</b> est un client mobile non-officiel donnant accès à de multiples ressources provenant de l'Espace Numérique de Travail de l'Université Côte d'Azur. Utilisant React Native, il est compatible avec la grande majorité des dispositifs mobiles (<b>iOS et Android</b>). <b>Votre ENT. Dans votre poche.</b>
7+
</p>
48

5-
## Get started
9+
## ⚡️ Téléchargement
610

7-
1. Install dependencies
11+
**✨ Disponible sur iOS**
812

9-
```bash
10-
npm install
11-
```
13+
<a href='https://apps.apple.com/fr/app/unicenotes/id1668992337'><img width='200' alt='Get the app on App Store' src='https://github.com/UniceApps/UniceNotes-Website/raw/main/assets/img/appstore.png'/></a>
1214

13-
2. Start the app
15+
**✨ Disponible sur Android**
1416

15-
```bash
16-
npx expo start
17-
```
17+
<a href='https://play.google.com/store/apps/details?id=fr.hugofnm.unicenotes'><img width='200' alt='Get the app on Play Store' src='https://github.com/UniceApps/UniceNotes-Website/raw/main/assets/img/googleplay.png'/></a>
1818

19-
In the output, you'll find options to open the app in a
19+
## ⚠️ Documentation
2020

21-
- [development build](https://docs.expo.dev/develop/development-builds/introduction/)
22-
- [Android emulator](https://docs.expo.dev/workflow/android-studio-emulator/)
23-
- [iOS simulator](https://docs.expo.dev/workflow/ios-simulator/)
24-
- [Expo Go](https://expo.dev/go), a limited sandbox for trying out app development with Expo
21+
- Données : [Voir la documentation](https://github.com/UniceApps/UniceNotes/tree/main/.docs/DATA.md)
22+
- Erreurs : [Voir la documentation](https://github.com/UniceApps/UniceNotes/tree/main/.docs/ERRORS.md)
23+
- Haptics : [Voir la documentation](https://github.com/UniceApps/UniceNotes/tree/main/.docs/HAPTICS.md)
24+
- Utilisation : [Voir la documentation](https://github.com/UniceApps/UniceNotes/tree/main/.docs/USAGE.md)
25+
- API : [Voir la documentation](https://github.com/UniceApps/UniceAPI)
2526

26-
You can start developing by editing the files inside the **app** directory. This project uses [file-based routing](https://docs.expo.dev/router/introduction).
27+
## ⚙️ Contribution
2728

28-
## Get a fresh project
29+
Merci pour votre intérêt pour le projet ! Si vous souhaitez contribuer, contactez-nous grâce à l'email suivant : [app at metrixmedia.fr](mailto://app@metrixmedia.fr) ou en créant une issue / pull request sur GitHub.
2930

30-
When you're ready, run:
31+
## 📜 Licence
32+
33+
L'application UniceNotes et son site web sont sous licence [MIT License](https://github.com/UniceApps/UniceNotes/raw/main/LICENSE).
34+
\
35+
Le logo UniceNotes est sous licence [Creative Commons Attribution-NonCommercial-NoDerivatives 4.0 International](
36+
https://creativecommons.org/licenses/by-nc-nd/4.0/).
37+
\
38+
Certains composants intégrés peuvent être sous des licences différentes, consultez le [site web](https://notes.metrixmedia.fr/credits) pour plus d'informations.
39+
40+
## 🔒 Confidentialité
41+
42+
> [!TIP]
43+
> La version 3.0.0 de l'application est uniquement locale. Toutes les données restent sur le téléphone. Ce paragraphe ne s'applique donc pas.
44+
45+
L'application UniceNotes ne collecte **aucune** donnée personnelle.
46+
\
47+
L'application UniceNotes utilise :
48+
- Le nom d'utilisateur
49+
- Le nom complet
50+
- La photo de profil
51+
- Les notes (avec les moyennes)
52+
- L'emploi du temps
53+
- Les absences, retards et exclusions
54+
55+
56+
avec votre consentement (en vous connectant sur l'application et en acceptant les conditions d'utilisation) afin de vous fournir une expérience utilisateur optimale.
57+
Ces données sont récupérées depuis le site web Intracursus ou ADE de l'Université Côte d'Azur et ne quittent pas votre appareil.
58+
\
59+
Les données de connexion sont **stockées sur votre appareil** et ne sont pas stockées sur un serveur (Seuls vos identifiants sont utilisés sur ```login.univ-cotedazur.fr``` afin de vous identifier et créer un token).
60+
\
61+
Les données de connexion (critiques) sont stockées dans un format **crypté** dans la Keychain d'Apple / Keystore d'Android et ne peuvent être déchiffrées que par l'utilisateur lorsqu'il s'identifie grâce à un code ou grâce à une option de connxion biométrique. [Voir l'API SecureStore](https://docs.expo.dev/versions/latest/sdk/securestore/)
62+
\
63+
Les données non-critiques sont stockées dans un stockage persistant nommé AsyncStorage de React Native. [Voir l'API AsyncStorage](https://react-native-async-storage.github.io/async-storage/docs/usage/)
64+
65+
## 🛠️ Build
66+
67+
Pour construire l'application, vous aurez besoin de Node.js, npm, Expo CLI, EAS CLI et un compte Expo.
68+
69+
> [!IMPORTANT]
70+
> Attention, vous devez posséder un compte payant Apple Developer ou Google Play Console pour pouvoir construire l'application pour iOS ou Android.
3171
3272
```bash
33-
npm run reset-project
73+
# Installer Expo CLI et EAS CLI
74+
npm install -g expo-cli eas-cli
75+
76+
# Cloner le dépôt
77+
git clone https://github.com/UniceApps/UniceNotes.git
78+
79+
# Aller dans le dossier
80+
cd UniceNotes
81+
82+
# Installer les dépendances
83+
npm install
84+
85+
# Démarrer l'application en mode développement
86+
# Vous devez posséder Expo Go sur votre appareil
87+
npx expo
88+
89+
# Construire l'application
90+
eas login
91+
eas build --platform all
3492
```
3593

36-
This command will move the starter code to the **app-example** directory and create a blank **app** directory where you can start developing.
94+
Si le code source de l'application est modifié, la version compilée de celle-ci ne fonctionnera plus sur les serveurs officiels dû à des mécanismes de protection intégrés à l'API pour éviter les abus. Toute tentative de contournement de ces mécanismes est interdite et peut conduire à des bannissements automatiques d'adresses IP.
95+
96+
## 📄 Légal
97+
98+
The Apple logo® and the App Store® are trademarks of Apple Inc., registered in the U.S. and other countries.
99+
100+
The Google Play Store logo® and the Google Play Store® are trademarks of Google Inc., registered in the U.S. and other countries.
37101

38-
## Learn more
102+
## 📝 Notes
39103

40-
To learn more about developing your project with Expo, look at the following resources:
104+
UniceNotes n'est aucunement affilié à l'Université Côte d'Azur, Polytech Nice Sophia Antipolis ou à l'I.U.T. Nice Côte d'Azur.
105+
Toute ressemblance avec le nom de l'application, le logo et l'interface ne saurait être que fortuite.
41106

42-
- [Expo documentation](https://docs.expo.dev/): Learn fundamentals, or go into advanced topics with our [guides](https://docs.expo.dev/guides).
43-
- [Learn Expo tutorial](https://docs.expo.dev/tutorial/introduction/): Follow a step-by-step tutorial where you'll create a project that runs on Android, iOS, and the web.
107+
Toute utilisation de l'application UniceNotes est sous la seule responsabilité de l'utilisateur.
44108

45-
## Join the community
109+
Cette application agit comme un navigateur internet où l'utilisateur effectue des pseudos-requêtes (GET HTTPS) sur l'intranet de l'Université Côte d'Azur. Cette application ne contient aucun code malveillant et ne vise pas à nuire à l'Université Côte d'Azur ou à ses utilisateurs. Les éventuelles suspiscions de "fuites de données" sont infondées dûes à la nature de l'application (les données sont stockées sur l'appareil de l'utilisateur et non sur des serveurs tiers). Plus d'infos : [Voir la documentation](https://github.com/UniceApps/UniceAPIDocumentation).
46110

47-
Join our community of developers creating universal apps.
111+
## 🤝 Conditions d'utilisation :
112+
[Consulter les conditions d'utilisation](https://notes.metrixmedia.fr/eula)
48113

49-
- [Expo on GitHub](https://github.com/expo/expo): View our open source platform and contribute.
50-
- [Discord community](https://chat.expo.dev): Chat with Expo users and ask questions.
114+
---
115+
L'application UniceNotes utilise Expo, un framework basé sur React Native.
116+
\
117+
<a href="https://expo.dev"> <img src='https://raw.githubusercontent.com/UniceApps/UniceNotes/main/.docs/assets/expo-bottomlogo.png'/></a>

app.json

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -32,14 +32,14 @@
3232
"CADisableMinimumFrameDurationOnPhone": true
3333
},
3434
"bundleIdentifier": "fr.hugofnm.unicenotes",
35-
"buildNumber": "12.0.0",
35+
"buildNumber": "13.0.0",
3636
"config": {
3737
"usesNonExemptEncryption": false
3838
}
3939
},
4040
"android": {
4141
"package": "fr.hugofnm.unicenotes",
42-
"versionCode": 35
42+
"versionCode": 36
4343
},
4444
"extra": {
4545
"eas": {

0 commit comments

Comments
 (0)