{"id":19179545,"url":"https://github.com/mathieubesson/session-planner-api","last_synced_at":"2025-02-23T01:40:38.449Z","repository":{"id":241956318,"uuid":"802134886","full_name":"MathieuBesson/session-planner-api","owner":"MathieuBesson","description":"API of the session planner project intended for the sports association Union Sportive Vernoise Badminton","archived":false,"fork":false,"pushed_at":"2024-08-31T15:50:07.000Z","size":192,"stargazers_count":0,"open_issues_count":0,"forks_count":0,"subscribers_count":1,"default_branch":"main","last_synced_at":"2025-01-04T03:12:40.800Z","etag":null,"topics":["adonisjs","nodejs","npm","postgresql"],"latest_commit_sha":null,"homepage":"","language":"TypeScript","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"gpl-3.0","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/MathieuBesson.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":"2024-05-17T15:28:08.000Z","updated_at":"2024-08-31T15:50:10.000Z","dependencies_parsed_at":"2024-06-04T23:38:59.857Z","dependency_job_id":"5842a68a-186a-4f6f-b37f-4701fa25a477","html_url":"https://github.com/MathieuBesson/session-planner-api","commit_stats":null,"previous_names":["mathieubesson/session-planner","mathieubesson/session-planner-api"],"tags_count":0,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/MathieuBesson%2Fsession-planner-api","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/MathieuBesson%2Fsession-planner-api/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/MathieuBesson%2Fsession-planner-api/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/MathieuBesson%2Fsession-planner-api/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/MathieuBesson","download_url":"https://codeload.github.com/MathieuBesson/session-planner-api/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":240258116,"owners_count":19772969,"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":["adonisjs","nodejs","npm","postgresql"],"created_at":"2024-11-09T10:43:28.407Z","updated_at":"2025-02-23T01:40:38.429Z","avatar_url":"https://github.com/MathieuBesson.png","language":"TypeScript","readme":"# Session Planner API\n\n## Description\n\n**Session Planner** is a custom solution developed for the Union Sportive Vernoise Badminton to facilitate session sign-ups. This repository contains the API for the solution, developed using the **Adonis JS** framework, serving as the data source for the web application.\n\n## Prerequisites\n\n![docker](https://img.shields.io/badge/docker-v27-2496ED?logo=docker\u0026logoColor=white\u0026labelColor=2496ED\u0026color=white)\n![docker-compose](https://img.shields.io/badge/docker--compose-v1-2496ED?logo=docker\u0026logoColor=white\u0026labelColor=2496ED\u0026color=white)\n![node.js](https://img.shields.io/badge/node.js-v20-339933?logo=nodedotjs\u0026logoColor=white\u0026labelColor=339933\u0026color=white)\n![npm](https://img.shields.io/badge/npm-v10-CB3837?logo=npm\u0026logoColor=white\u0026labelColor=CB3837\u0026color=white)\n\n## Installation\n\n1. **Clone the repository**:\n   ```bash\n   git clone https://github.com/MathieuBesson/session-planner-api\n   ```\n2. **Navigate to the project directory**:\n   ```bash\n   cd session-planner-api\n   ```\n3. **Configure environment variables**:\n   - Create a `.env` file from `.env.example`\n   - Configure the environment variables, including the PostgreSQL database connection.\n4. **Start the project's Docker containers**:\n   ```bash\n   docker-compose up -d\n   ```\n5. **Run the migrations**:\n   ```bash\n   docker exec -it session-planner-api node ace migration:run\n   ```\n6. **Run the seeders**:\n   ```bash\n   docker exec -it session-planner-api node ace db:seed\n   ```\n\n## Start\n\nTo start the containers, run the following command:\n\n```bash\ndocker-compose up\n```\n\n- The API will be accessible at: [http://localhost:8080](http://localhost:8080)\n- The database visualization tool will be available at: [http://localhost:8081](http://localhost:8081)\n\n## Frontend\n\nThe frontend of **Session Planner** is a web application built with **Next.js**. You can find it here: [session-planner-pwa](https://github.com/MathieuBesson/session-planner-pwa).\n\n## TODO\n\n- Validate API data types using schemas ([zod](https://zod.dev/), [vine.js](https://vinejs.dev))\n- Add JS documentation to functions\n- Add unit tests\n- Add Swagger documentation for the API\n- Resolve the remaining TODOs\n\n## License\n\nThis project is licensed under the GPL License. See the [LICENSE](./LICENSE) file for more details.\n","funding_links":[],"categories":[],"sub_categories":[],"project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fmathieubesson%2Fsession-planner-api","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fmathieubesson%2Fsession-planner-api","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fmathieubesson%2Fsession-planner-api/lists"}