{"id":18802964,"url":"https://github.com/hadv/twim-api","last_synced_at":"2026-04-12T00:38:25.528Z","repository":{"id":149599196,"uuid":"63408989","full_name":"hadv/twim-api","owner":"hadv","description":"Twim API","archived":false,"fork":false,"pushed_at":"2016-07-15T09:18:26.000Z","size":13,"stargazers_count":0,"open_issues_count":0,"forks_count":0,"subscribers_count":1,"default_branch":"master","last_synced_at":"2024-12-29T20:20:19.809Z","etag":null,"topics":["expressjs","mocha","mongodb","mongoose","nodejs","passportjs","superagent"],"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/hadv.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":"2016-07-15T09:18:02.000Z","updated_at":"2016-07-15T09:18:27.000Z","dependencies_parsed_at":null,"dependency_job_id":"b799a4df-79db-4ab1-bd7a-440eb78caf6b","html_url":"https://github.com/hadv/twim-api","commit_stats":null,"previous_names":[],"tags_count":0,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/hadv%2Ftwim-api","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/hadv%2Ftwim-api/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/hadv%2Ftwim-api/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/hadv%2Ftwim-api/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/hadv","download_url":"https://codeload.github.com/hadv/twim-api/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":239735262,"owners_count":19688262,"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":["expressjs","mocha","mongodb","mongoose","nodejs","passportjs","superagent"],"created_at":"2024-11-07T22:32:08.411Z","updated_at":"2026-01-05T09:30:16.141Z","avatar_url":"https://github.com/hadv.png","language":"JavaScript","funding_links":[],"categories":[],"sub_categories":[],"readme":"Firstly, run `npm install` to download all the dependencies modules\n\nThen you can run `npm test` to run all the test\n\n\n==========\nRunning the REST API on the local machine\n\n1. install and start mongodb\n2. run `npm start` to start the REST API server (install npm and nodejs if need)\n3. REST API URI\n  - All the REST API is authenticate by bearer,\n    to call the api you need to pass the token key in the request header or in query param.\n    - header: [Authorization: Bearer suMwoiihHZkYuYq]\n    ```\n      GET /api/v1/user/admin HTTP/1.1\n      Host: localhost:3000\n      Content-Type: application/json\n      Authorization: Bearer suMwoiihHZkYuYq\n      Cache-Control: no-cache\n      Postman-Token: dd7ec54c-cb97-fb29-59a0-87d9cde68233\n    ```\n    - query param: /?access_token=suMwoiihHZkYuYq\n    ```\n    http://localhost:3000/api/v1/category/list/0/?access_token=suMwoiihHZkYuYq\n    ```\n\n  - list category: http://localhost:3000/api/v1/category/list/:date\n  ```\n  [  \n   {  \n      \"_id\":\"abcxyz\",\n      \"name\":\"Electronics\",\n      \"description\":\"Talking about all the electricity devices.\",\n      \"level\":\"N1\",\n      \"__v\":0,\n      \"updated_at\":\"2016-01-12T03:56:15.792Z\",\n      \"created_at\":\"2016-01-12T03:56:15.790Z\",\n      \"disp_order\":2,\n      \"topic_count\":5,\n      \"id\":\"abcxyz\"\n    }\n   ]\n  ```\n\n  - list topic by category: http://localhost:3000/api/v1/topic/list/:id/:date\n  ```\n  [  \n   {  \n      \"_id\":\"google\",\n      \"title\":\"Alpha-Beta is for Google\",\n      \"short_desc\":\"As Sergey and I wrote in the original founders letter 11 years ago\",\n      \"description\":\"We did a lot of things that seemed crazy at the time. Many of those crazy things.\",\n      \"category\":\"abcxyz\",\n      \"__v\":0,\n      \"updated_at\":\"2016-01-12T03:56:15.807Z\",\n      \"created_at\":\"2016-01-12T03:56:15.807Z\",\n      \"disp_order\":4,\n      \"id\":\"google\"\n    }\n   ]\n  ```\n\n  - get topic by id: http://localhost:3000/api/v1/topic/id/:id\n  ```\n  {  \n     \"_id\":\"google\",\n     \"title\":\"Alpha-Beta is for Google\",\n     \"short_desc\":\"As Sergey and I wrote in the original founders letter 11 years ago\",\n     \"description\":\"We did a lot of things that seemed crazy at the time. Many of those crazy things.\",\n     \"category\":\"abcxyz\",\n     \"__v\":0,\n     \"updated_at\":\"2016-01-12T03:56:15.807Z\",\n     \"created_at\":\"2016-01-12T03:56:15.807Z\",\n     \"disp_order\":4,\n     \"id\":\"google\"\n  }  \n  ```\n\n  - get all feedback by userid: http://localhost:3000/api/v1/feedback/userid/hadv/0/?access_token=suMwoiihHZkYuYq\n  ```\n  [{  \n      \"_id\":\"56a5c2570d92fc9e1e826e88\",\n      \"talk\":\"Electronics\",\n      \"topic\":\"Talking about all the electricity devices.\",\n      \"rater\":\"hadv\",\n      \"ratee\":\"kk\",\n      \"__v\":0,\n      \"updated_at\":\"2016-01-25T06:36:07.139Z\",\n      \"created_at\":\"2016-01-25T06:36:07.138Z\",\n      \"feedbacks\":[  \n         {  \n            \"title\":\"grammar\",\n            \"note\":\"So good! \u003c3\",\n            \"_id\":\"56a5c2570d92fc9e1e826e8a\",\n            \"point\":5,\n            \"id\":\"56a5c2570d92fc9e1e826e8a\"\n         },\n         {  \n            \"title\":\"pronoucian\",\n            \"note\":\"Pfffff! (y)\",\n            \"_id\":\"56a5c2570d92fc9e1e826e89\",\n            \"point\":10,\n            \"id\":\"56a5c2570d92fc9e1e826e89\"\n         }\n      ],\n      \"id\":\"56a5c2570d92fc9e1e826e88\"\n   },\n   {  \n      \"_id\":\"56a5c2570d92fc9e1e826e8b\",\n      \"talk\":\"Laptops\",\n      \"topic\":\"Talking about all the electricity devices.\",\n      \"rater\":\"kk\",\n      \"ratee\":\"hadv\",\n      \"__v\":0,\n      \"updated_at\":\"2016-01-25T06:36:07.146Z\",\n      \"created_at\":\"2016-01-25T06:36:07.146Z\",\n      \"feedbacks\":[  \n         {  \n            \"title\":\"grammar\",\n            \"note\":\"So poor! \u003c3\",\n            \"_id\":\"56a5c2570d92fc9e1e826e8d\",\n            \"point\":1,\n            \"id\":\"56a5c2570d92fc9e1e826e8d\"\n         },\n         {  \n            \"title\":\"pronoucian\",\n            \"note\":\"so sad! :(\",\n            \"_id\":\"56a5c2570d92fc9e1e826e8c\",\n            \"point\":2,\n            \"id\":\"56a5c2570d92fc9e1e826e8c\"\n         }\n      ],\n      \"id\":\"56a5c2570d92fc9e1e826e8b\"\n   }]\n  ```\n\n  - add new feedback: [POST: http://localhost:3000/api/v1/feedback/add]\n  input data in the body as below:\n  ```\n  {\n    talk: 'Mobile',\n    topic: 'Talking about all the electricity devices.',\n    rater: 'hadv',\n    ratee: 'kk',\n    feedbacks: [\n      {\n        title: 'grammar',\n        point: 5,\n        note: 'So good! \u003c3'\n      },\n      {\n        title: 'pronoucian',\n        point: 10,\n        note: 'Pfffff! (y)'\n      }\n    ]\n  }  \n  ```\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fhadv%2Ftwim-api","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fhadv%2Ftwim-api","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fhadv%2Ftwim-api/lists"}