{"id":16407547,"url":"https://github.com/ltossian/grader","last_synced_at":"2025-03-23T05:31:25.115Z","repository":{"id":223537480,"uuid":"754882379","full_name":"LTOssian/grader","owner":"LTOssian","description":"Grader est une plateforme de notation et de génération de bulletin de notes sous format PDF, afin de faciliter et accélérer les retours de nos enseignants @HETIC","archived":false,"fork":false,"pushed_at":"2024-12-14T11:39:55.000Z","size":1329,"stargazers_count":5,"open_issues_count":3,"forks_count":0,"subscribers_count":1,"default_branch":"main","last_synced_at":"2025-03-18T18:14:18.429Z","etag":null,"topics":["angular","clean-code","express","postgresql","typescript"],"latest_commit_sha":null,"homepage":"","language":"TypeScript","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":null,"status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/LTOssian.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":null,"code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null}},"created_at":"2024-02-08T23:59:28.000Z","updated_at":"2024-12-14T11:39:58.000Z","dependencies_parsed_at":"2024-10-28T20:36:00.798Z","dependency_job_id":null,"html_url":"https://github.com/LTOssian/grader","commit_stats":null,"previous_names":["ltossian/grader"],"tags_count":0,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/LTOssian%2Fgrader","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/LTOssian%2Fgrader/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/LTOssian%2Fgrader/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/LTOssian%2Fgrader/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/LTOssian","download_url":"https://codeload.github.com/LTOssian/grader/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":245061382,"owners_count":20554563,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["angular","clean-code","express","postgresql","typescript"],"created_at":"2024-10-11T06:14:12.606Z","updated_at":"2025-03-23T05:31:24.013Z","avatar_url":"https://github.com/LTOssian.png","language":"TypeScript","readme":"# Grader\n\n## Table des matières\n\n- [Contexte](#contexte)\n- [Installation](#installation)\n  - [Avec Docker](#avec-docker)\n  - [Sans Docker](#sans-docker)\n- [API Documentation](#api-documentation)\n- [Infrastructure et architecture](#infrastructure-et-architecture)\n  - [Ce que j'ai appris](#ce-que-jai-appris)\n  - [Développement continu](#développement-continu)\n- [Remerciement](#remerciement)\n- [Ressources](#ressources)\n- [Auteur](#auteur)\n\n## Contexte\n\nGrader est un projet réalisé en solo dans le cadre du cours d'API à HETIC. La consigne principale est de générer un PDF avec une API, le reste est du bonus.\n\nL'application Grader vise à générer les bulletins de notes d'étudiants sous format PDF.\n\n![demo page](./documentation/app-model.png)\n\n## Installation\n\n### Avec Docker\n\n```bash\nmake up-dev # ou make up-prod\n```\n\nSi make ne fonctionne pas:\n\n```bash\ndocker-compose -p grader_dev -f docker-compose.yml -f docker-compose.dev.yml up -d --build # env dev\ndocker-compose -p grader_prod up -d --build # env prod\n```\n\n### Sans Docker\n\n```bash\n# depuis la racine\n\n# mettez en place la base de donnée\npsql -U username -d database_name -a -f ./db_migrations/migrations_1_init_db.sql\n\n# depuis la racine\ncd server\n\n# mettez en place le .env\necho \"DATABASE_URL=\u003cURL de votre database ici\u003e\" \u003e .env\n\n# installer les dépendances et lancer l'app\nnpm install \u0026\u0026 npm run build\nnpm run start:prod #ou start:dev\n\n# depuis la racine\ncd client\nnpm install \u0026\u0026 npm run build\nnpm run start\n```\n\nInteragissez avec l'api via `http://localhost:4001/api/`\n\nInteragissez avec le client via `http://localhost:4200/` en dev ou `http://localhost:8080/` en prod\n\n## API Documentation\n\nLe fichier `./documentation/Grader-Louisan-tchitoula.postman_collection.json` peut être importé dans postman afin d'obtenir la collection d'endpoints de l'API et les tester !\n\n## Infrastructure et architecture\n\n![Schema of the project's infrastrcture](./documentation/infrastructure_schema.png)\n\n### Ce que j'ai appris\n\nAvec ces gros objectifs techniques, Grader m'a permis d'approfondir beaucoup d'aspects du développement d'application web.\n\n#### DevOps\n\nLe développement s'est déroulé entièrement dans des conteneurs Docker.\n\nJ'ai pu appliquer des subtilités apprises dans la documentation comme le `multi-stage building` afin de créer des images de production ou de développement à partir d'un unique Dockerfile par infrastructure.\n\n#### Design Pattern (et 0.01% de la notion de 'Clean Code')\n\nJ'ai trouvé un intêret à intégrer dans mon code les patternes Singleton et Abstract\nBuilder (i.e: `router.abstract.ts`, `api-service.abstract.ts`, `validator.ts`).\n\nCes derniers m'ont permis d'écrire du code plus rapidement tout en le rendant plus robuste et consistant.\n\n#### Nouvelle version d'Angular (17)\n\n- Prise en main du nouveau paradigme (Angular promeut dorénavant un code plus réactif avec `signal(), input(), inject()`).\n- Nouvelle syntaxe de templating (`@if, @for, @empty`...).\n\nJ'ai aussi pris le temps de découvrir des notions manquantes dans mon bagage technique Angular :\n\n- Les Guards de routes.\n- Les Reactive Forms.\n- RxJs (Surtout pour les `Subscription` et les `Subject`).\n\n#### TypeScript\n\nPour un code maintenable et évolutif, j'ai du creuser dans de nouvelles notions découverte dans la documentation:\n\n- L'héritage entre les interfaces.\n- Les interfaces de classes `abstract`.\n- Le typage générique.\n- Les Utility Types.\n\n### Développement continu\n\nL'application est entièrement Dockerisée. Pour la suite, il serait intéressant d'ajouter une couche d'authentifiaction et d'autorisation afin de la déployer.\n\nPistes :\n\n- Vercel: hoster le backend et/ou infrastructure de base de donnée ? **A creuser**.\n- Scaleway: obtenir mon domaine et reprendre l'image nginx du côté client pour un déploiement léger et rapide.\n- Github Actions: pour l'automatisation du déploiement, puisque Scaleway permet la connexion remote (par ssh) vers le domaine, builder le container puis le `cp` dans l'environnement remote serait simple.\n\n## Remerciement\n\nMerci à Julien Heitz et Djédjé Gboble pour les code reviews, les sessions de tests et le partage de ressources durant le développement !\n\nDjédjé GBOBLE :\n\n- [LinkedIn](https://www.linkedin.com/in/djédjé-gboble-3100b1228/)\n- [GitHub](https://github.com/Kobrae-San)\n\nJulien HEITZ :\n\n- [LinkedIn](https://www.linkedin.com/in/heitzjulien/)\n- [GitHub](https://github.com/heitzjulien)\n\n## Ressources\n\n- [Angular Documentation](https://angular.dev/overview)\n- [PDFKit Documentation](http://pdfkit.org/docs/getting_started.html) \u0026 [PDFKit Table](https://github.com/natancabral/pdfkit-table/tree/main)\n- [StackOverflow question: How to read Content-Dispotion from response Headers](https://stackoverflow.com/questions/42898162/how-to-read-content-disposition-headers-from-server-response-angular-2) ? (To get the filename of the generated PDF in my case)\n- [This issue on Angular's repository](https://github.com/angular/angular/issues/18586), bug from 2017 but still to date lol\n- [Docker's documentation](https://docs.docker.com/get-started/09_image_best/)\n\n## Auteur\n\nLouisan TCHITOULA\n\n- [LinkedIn](https://www.linkedin.com/in/louisan-tchitoula/)\n","funding_links":[],"categories":[],"sub_categories":[],"project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fltossian%2Fgrader","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fltossian%2Fgrader","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fltossian%2Fgrader/lists"}