{"id":26606868,"url":"https://github.com/okayshankha/tracetrail","last_synced_at":"2026-04-11T07:44:26.185Z","repository":{"id":183107231,"uuid":"631015061","full_name":"okayshankha/tracetrail","owner":"okayshankha","description":"Simple request logger for Express or Express Like apps. Effortlessly record and identify input/output payloads.","archived":false,"fork":false,"pushed_at":"2024-07-23T19:42:31.000Z","size":9198,"stargazers_count":1,"open_issues_count":2,"forks_count":1,"subscribers_count":1,"default_branch":"main","last_synced_at":"2025-10-13T09:16:02.438Z","etag":null,"topics":["debugging","nodejs","request-logger","request-logging","request-response","rest-api","typescript"],"latest_commit_sha":null,"homepage":"","language":"CSS","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"agpl-3.0","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/okayshankha.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-04-21T17:46:54.000Z","updated_at":"2024-07-23T19:42:35.000Z","dependencies_parsed_at":"2024-07-23T22:10:11.938Z","dependency_job_id":null,"html_url":"https://github.com/okayshankha/tracetrail","commit_stats":null,"previous_names":["okayshankha/tracetrail"],"tags_count":15,"template":false,"template_full_name":null,"purl":"pkg:github/okayshankha/tracetrail","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/okayshankha%2Ftracetrail","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/okayshankha%2Ftracetrail/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/okayshankha%2Ftracetrail/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/okayshankha%2Ftracetrail/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/okayshankha","download_url":"https://codeload.github.com/okayshankha/tracetrail/tar.gz/refs/heads/main","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/okayshankha%2Ftracetrail/sbom","scorecard":null,"host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":286080680,"owners_count":31673067,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2026-04-10T17:19:37.612Z","status":"online","status_checked_at":"2026-04-11T02:00:05.776Z","response_time":54,"last_error":null,"robots_txt_status":"success","robots_txt_updated_at":"2025-07-24T06:49:26.215Z","robots_txt_url":"https://github.com/robots.txt","online":true,"can_crawl_api":true,"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":["debugging","nodejs","request-logger","request-logging","request-response","rest-api","typescript"],"created_at":"2025-03-23T22:23:48.818Z","updated_at":"2026-04-11T07:44:26.145Z","avatar_url":"https://github.com/okayshankha.png","language":"CSS","funding_links":[],"categories":[],"sub_categories":[],"readme":"# Tracetrail\n\nIntroducing \"Tracetrail\" -  the npm package that streamlines the API debugging process. This package enables you to record the input and output payloads transferred to and from your client or server with ease.\n\nTracetrail makes it simple to find out what payload was transmitted by the client or received as a response from the server. This package is particularly created to assist you in more effectively debugging your APIs, making it a crucial tool for developers.\n\nPayload Recorder is ideal for anybody working on a large-scale application or a basic project. It makes debugging easier, allowing you to rapidly detect and handle any problems that may develop. You can quickly navigate through the recorded payloads and receive insights into the performance of your API thanks to its user-friendly interface.\n\n\n## Installation\n\n``` bash\nnpm install tracetrail\n```\n\n## Usage\n\nFor regular javascript code\n```javascript\nconst { TraceTrail } = require('tracetrail')\n```\n\nFor CJS / Module Imports\n```javascript\nimport { TraceTrail } from 'tracetrail' \n```\n\n```javascript\nimport { TraceTrail } from 'tracetrail' \nimport express from 'express'\n\nconst port = 4444\nconst app = express()\n\n// You can use a separate database to keep things neat and clean.\nconst traceTrail = new TraceTrail('mongodb://localhost:27017/TraceTrail', {\n  AUTO_CLEAN_RECORDS_OLDER_THAN: 10,          // Optional [Default: 60]\n  AUTO_CLEAN_RECORDS_OLDER_THAN_UNIT: 'days'  // Optional [Default: days]\n})\n\n// You need to use traceTrail.MiddleWare to make this package work.\napp.use(traceTrail.MiddleWare)\n\napp.listen(port, () =\u003e {\n    console.log(`App listening on port ${port}`)\n})\n```\n\n## UI\n\nTo get the inbuilt UI you can easily code it like this.\n\n![image](https://i.imgur.com/xtUuRCe.jpg)\n\n``` javascript\nimport { TraceTrail } from 'tracetrail'\nimport express from 'express'\n\nconst port = 4444\nconst app = express()\n\n// You can use a separate database to keep things neat and clean.\nconst traceTrail = new TraceTrail('mongodb://localhost:27017/TraceTrail', {\n  AUTO_CLEAN_RECORDS_OLDER_THAN: 10,          // Optional [Default: 60]\n  AUTO_CLEAN_RECORDS_OLDER_THAN_UNIT: 'days'  // Optional [Default: days]\n})\n\n// Get the UI\napp.use(\n  '/tracetrail',\n  traceTrail.UI({\n    LOGIN_PASSWORD: '1234',                      // Optional [Default: 1234]\n    // SALT_ROUNDS: 10,                          // Optional [Default: 12]\n    // SECRET_KEY: Config.SECRET_KEY as string,  // Optional [Default: Auto]\n    // JWT_EXPIRY_SECS: 60 * 60 * 24,            // Optional [Default: 1 day]\n  }),\n)\n\n// You need to use traceTrail.MiddleWare to make this package work.\napp.use(traceTrail.MiddleWare)\n\napp.listen(port, () =\u003e {\n    console.log(`App listening on port ${port}`)\n})\n```\n\n\n## Developers Guide\n\nIf you want to set up the project in your local follow these steps:\n\n- Terminal #1\n  - Clone the repository\n  - Run following command ```npm i```\n  - Create .env file and add the following bare minimum environment variables\n    \n    ```shell\n    DB_URL=mongodb:/localhost:27017/TraceTrail\n    PORT=7777\n    TRACETRAIL_ENV=DEV\n    ```\n\n  - Now run ```npm run dev```\n  - Go to the examples folder and pick any file of your choice JavaScript one or TypeScript one.\n  - Make sure to update the MongoDB url.\n---\n\nThat's it, you are all set. Now you can open your browser and open ```http://localhost:7777/tracetrail``` it will open TraceTrail UI.\n\nIf you haven't changed any ports, then the following would be true.\n- Backend Server: ```http://localhost:7777```\n- React Front End: ```http://localhost:7778```\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fokayshankha%2Ftracetrail","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fokayshankha%2Ftracetrail","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fokayshankha%2Ftracetrail/lists"}