{"id":20737583,"url":"https://github.com/rasif-sahl/primis-tracking-api","last_synced_at":"2025-07-27T00:32:39.610Z","repository":{"id":261388851,"uuid":"884092662","full_name":"rasif-sahl/primis-tracking-api","owner":"rasif-sahl","description":null,"archived":false,"fork":false,"pushed_at":"2024-11-07T10:20:13.000Z","size":214,"stargazers_count":0,"open_issues_count":0,"forks_count":0,"subscribers_count":1,"default_branch":"master","last_synced_at":"2025-03-11T11:34:57.968Z","etag":null,"topics":[],"latest_commit_sha":null,"homepage":null,"language":"JavaScript","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/rasif-sahl.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-11-06T05:58:39.000Z","updated_at":"2024-11-07T10:20:17.000Z","dependencies_parsed_at":"2024-11-06T10:28:54.920Z","dependency_job_id":"fc524146-973a-4af7-9cb5-9e7b74194348","html_url":"https://github.com/rasif-sahl/primis-tracking-api","commit_stats":null,"previous_names":["rasif-sahl/primis-tracking-api"],"tags_count":0,"template":false,"template_full_name":null,"purl":"pkg:github/rasif-sahl/primis-tracking-api","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/rasif-sahl%2Fprimis-tracking-api","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/rasif-sahl%2Fprimis-tracking-api/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/rasif-sahl%2Fprimis-tracking-api/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/rasif-sahl%2Fprimis-tracking-api/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/rasif-sahl","download_url":"https://codeload.github.com/rasif-sahl/primis-tracking-api/tar.gz/refs/heads/master","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/rasif-sahl%2Fprimis-tracking-api/sbom","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":267276957,"owners_count":24063217,"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","status":"online","status_checked_at":"2025-07-26T02:00:08.937Z","response_time":62,"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":[],"created_at":"2024-11-17T06:14:55.825Z","updated_at":"2025-07-27T00:32:39.544Z","avatar_url":"https://github.com/rasif-sahl.png","language":"JavaScript","funding_links":[],"categories":[],"sub_categories":[],"readme":"# Prismis APIs\n\n## Requirements\n\n- Node js\n\n\u003e I am using node version `22.3.0`\n\n## Getting Started\n\n- Clone the project - `git clone https://github.com/rasif-sahl/primis-tracking-api.git`\n- Then run - `cd primis-tracking-api`\n- To install the dependencies run - `npm install`\n- Copy the variable in the `env-example` file.\n- Create `.env` file and then add the copied variable here and replace them with your own values.\n- To run the project - `npm run start` or `npm start`\n- By default you can access the apis with this url - [http://localhost:4000](http://localhost:4000) \n- If you need to change the api endpoint you can do it in the `.env` file.\n\n## Commands (Test)\n\n- `curl -H \"Authorization: your_secure_api_key\" -H \"Content-Type: application/json\" http://localhost:4000/api/tracking` run this command to check the api\n\n- `curl -H \"Authorization: your_secure_api_key\" -H \"Content-Type: application/json\" http://localhost:4000/api/tracking/page/65f1888eca763954f8e1ca06`\n\n## Endpoints\n\nI have created 02 endpoints one is to get the list of trackings. and other is to get single tracking information\n\n- Tracking list - `http://localhost:4000/api/tracking`\n- Single tracking info - `http://localhost:4000/api/tracking/page/65f1888eca763954f8e1ca06`\n\n## Note\n\n- In the front end application only the single tracking info route is been used.\n- The API key that you are using in the express API should match with the front-end this to work properly.\n\n## File Structure\n\nFolder | Contents\n-------|---------\n`config` | Initially when i was starting this project I thought we need to connect it with the database. so configuration files are been added here\n`controllers` | All the controller related functions are included here. The is been used as a bridge between the routes and the services.\n`data` | All the static data is been included here \n`middleware` | Route authentication related middlewares are been included here.\n`routes/` | The api routes are been included here.\n`services` | Initially was planning to add the db queries here. But now I am using this to speak with the json object array\n`app.js` | This is the root file. And this is where this application starts.\n`env-example` | All the environment variable name are been added here.","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Frasif-sahl%2Fprimis-tracking-api","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Frasif-sahl%2Fprimis-tracking-api","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Frasif-sahl%2Fprimis-tracking-api/lists"}