{"id":19179579,"url":"https://github.com/mathieubesson/tricount-rat-api","last_synced_at":"2026-04-13T14:32:59.621Z","repository":{"id":171129910,"uuid":"641847980","full_name":"MathieuBesson/tricount-rat-api","owner":"MathieuBesson","description":"Application based on the simplified functionalities of Tricount. (FRONT)","archived":false,"fork":false,"pushed_at":"2024-08-31T16:24:56.000Z","size":370,"stargazers_count":0,"open_issues_count":0,"forks_count":0,"subscribers_count":1,"default_branch":"main","last_synced_at":"2025-01-04T03:12:47.812Z","etag":null,"topics":["docker","nextjs","nodejs","npm","postgresql","prisma"],"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":"2023-05-17T09:39:04.000Z","updated_at":"2024-08-31T16:27:33.000Z","dependencies_parsed_at":null,"dependency_job_id":"9b7af13a-ebac-4aaf-a32a-b8d4e0a227a6","html_url":"https://github.com/MathieuBesson/tricount-rat-api","commit_stats":null,"previous_names":["mathieubesson/tricount-rat","mathieubesson/tricount-rat-api"],"tags_count":0,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/MathieuBesson%2Ftricount-rat-api","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/MathieuBesson%2Ftricount-rat-api/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/MathieuBesson%2Ftricount-rat-api/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/MathieuBesson%2Ftricount-rat-api/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/MathieuBesson","download_url":"https://codeload.github.com/MathieuBesson/tricount-rat-api/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":240258152,"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":["docker","nextjs","nodejs","npm","postgresql","prisma"],"created_at":"2024-11-09T10:43:32.297Z","updated_at":"2026-04-13T14:32:59.573Z","avatar_url":"https://github.com/MathieuBesson.png","language":"TypeScript","funding_links":[],"categories":[],"sub_categories":[],"readme":"# TricountRat API\n\nThis application is based on the simplified features of [Tricount](https://www.tricount.com/fr/faire-les-comptes-entre-amis).\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\n## Configuration\n\n### Defining Environment Variables\n\nTo use your own environment variables, you need to redefine the variables present in the `.env.example` file by creating a new `.env` file with your chosen values.\n\n## Installation\n\nThe following command will start the `node`, `postgres`, and `pgadmin` containers required for the project using the images referenced in the `docker-compose.yml` file.\n\n```bash\ndocker-compose up --build -d\n```\n\nCreate the database:\n\n```bash\ndocker exec tricount-rat-app npx prisma migrate dev\n```\n\nSeed the database with mock data (already done by the previous command):\n\n```bash\ndocker exec tricount-rat-app npx prisma db seed\n```\n\nYou can now access the various tools on the following ports:\n\n- `API documentation`: [http://localhost:3000/api](http://localhost:3000/api) - API documented with Swagger\n- `Postgres`: [http://localhost:5432](http://localhost:5432)\n- `pgAdmin`: [http://localhost:5050](http://localhost:5050)\n\nLog in to the various tools using the credentials from your `.env` file.\n\n## Useful Information\n\n- Install dependencies directly from the container:\n\n```bash\ndocker exec tricount-rat-app npm install {package-name}\n```\n\n- Run the project in `production` mode:\n\n```bash\ndocker exec tricount-rat-app npm run start:prod\n```\n\n## Front-end\n\nThe front-end of **TricountRat** is a web application built with **Next.js**. You can find it here: [tricount-rat-front](https://github.com/MathieuBesson/tricount-rat-front).\n\n## TODO\n\n- Fix the many typing issues or lack of typing\n\n## License\n\nThis project is licensed under the GPL License. See the [LICENSE](./LICENSE) file for more details.\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fmathieubesson%2Ftricount-rat-api","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fmathieubesson%2Ftricount-rat-api","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fmathieubesson%2Ftricount-rat-api/lists"}