{"id":18283219,"url":"https://github.com/ungdev/ua-bouffe-api","last_synced_at":"2025-04-09T05:42:06.553Z","repository":{"id":35826685,"uuid":"219564660","full_name":"ungdev/UA-bouffe-api","owner":"ungdev","description":"API de l'UTT Arena permettant de gérer les commandes de restauration","archived":false,"fork":false,"pushed_at":"2024-12-05T12:49:43.000Z","size":473,"stargazers_count":1,"open_issues_count":3,"forks_count":0,"subscribers_count":10,"default_branch":"master","last_synced_at":"2025-02-15T00:17:58.436Z","etag":null,"topics":["hacktoberfest"],"latest_commit_sha":null,"homepage":"","language":"TypeScript","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/ungdev.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE","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":"2019-11-04T18:04:48.000Z","updated_at":"2024-12-05T12:49:47.000Z","dependencies_parsed_at":"2023-12-01T00:27:11.496Z","dependency_job_id":"0f282217-ddca-4d90-9e94-2dbea2904bcf","html_url":"https://github.com/ungdev/UA-bouffe-api","commit_stats":null,"previous_names":[],"tags_count":1,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/ungdev%2FUA-bouffe-api","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/ungdev%2FUA-bouffe-api/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/ungdev%2FUA-bouffe-api/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/ungdev%2FUA-bouffe-api/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/ungdev","download_url":"https://codeload.github.com/ungdev/UA-bouffe-api/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":247987107,"owners_count":21028891,"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":["hacktoberfest"],"created_at":"2024-11-05T13:08:16.484Z","updated_at":"2025-04-09T05:42:06.533Z","avatar_url":"https://github.com/ungdev.png","language":"TypeScript","funding_links":[],"categories":[],"sub_categories":[],"readme":"\n# UA Bouffe API\n[![Build status](https://github.com/ungdev/UA-bouffe-api/actions/workflows/ci.yml/badge.svg)](https://github.com/ungdev/UA-bouffe-api/actions/workflows/ci.yml)\n\nAPI du microservice [UA Bouffe](https://github.com/ungdev/UA-bouffe)\n\n## Installation\n### Prérequis\n- NodeJS\n- Pnpm\n- MySQL\n### Base de données\nCréer la base de données uabouffe\n```\nCREATE DATABASE uabouffe CHARACTER SET utf8;\n```\n### Installation de l'API et des dépendances\n\nIl faut maintenant clone le repo [UA-bouffe](https://github.com/ungdev/UA-bouffe) (avec les submodules) qui contient un jeu de données à mettre dans la DB.\n```\ngit clone https://github.com/ungdev/UA-bouffe-api\ncp .env.example .env\npnpm i\n```\n## Développement\n### Démarrer l'API en développement\n```\npnpm dev\n```\n### Avant de commit\nAfin de garder une certaine cohérence dans le code, on utilise EsLint et Prettier. Il faut donc bien lint le code avant de commit\n```\npnpm lint-fix\n```\n### Démarrer l'API en production\n```\npnpm build\npnpm start\n```\n\n### CI/CD\nLa pipeline de CI/CD est assurée par GitHub Actions.\n\nA chaque push sur master, GitHub Action lint le code, le build et trigger okd pour déployer le code en production ainsi que Slack pour notifier l'avancée de la vérification\nIl se passe en moyenne 5 minutes entre un push et un déploiement.\n\n### Diagramme de séquence lors d'une commande\n![Diagramme de séquence](./docs/sequence.svg)\n\n### Licence\nLe code est sous licence MIT.\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fungdev%2Fua-bouffe-api","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fungdev%2Fua-bouffe-api","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fungdev%2Fua-bouffe-api/lists"}