{"id":19956545,"url":"https://github.com/tbreuss/notes-api","last_synced_at":"2025-08-26T01:13:47.823Z","repository":{"id":104902496,"uuid":"158097278","full_name":"tbreuss/notes-api","owner":"tbreuss","description":":green_book: REST-API for Notes Management Tool","archived":false,"fork":false,"pushed_at":"2018-12-09T16:31:14.000Z","size":109,"stargazers_count":5,"open_issues_count":0,"forks_count":1,"subscribers_count":2,"default_branch":"master","last_synced_at":"2025-05-03T20:35:39.619Z","etag":null,"topics":["jwt-authentication","notes-app","php7","rest-api","yii2"],"latest_commit_sha":null,"homepage":"https://notes.tebe.ch","language":"PHP","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/tbreuss.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":"2018-11-18T15:20:44.000Z","updated_at":"2024-02-06T04:36:15.000Z","dependencies_parsed_at":null,"dependency_job_id":"c4410b51-35e3-482d-8939-14819c03e361","html_url":"https://github.com/tbreuss/notes-api","commit_stats":null,"previous_names":[],"tags_count":0,"template":false,"template_full_name":null,"purl":"pkg:github/tbreuss/notes-api","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/tbreuss%2Fnotes-api","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/tbreuss%2Fnotes-api/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/tbreuss%2Fnotes-api/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/tbreuss%2Fnotes-api/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/tbreuss","download_url":"https://codeload.github.com/tbreuss/notes-api/tar.gz/refs/heads/master","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/tbreuss%2Fnotes-api/sbom","scorecard":null,"host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":272155752,"owners_count":24883096,"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-08-25T02:00:12.092Z","response_time":1107,"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":["jwt-authentication","notes-app","php7","rest-api","yii2"],"created_at":"2024-11-13T01:34:44.951Z","updated_at":"2025-08-26T01:13:47.816Z","avatar_url":"https://github.com/tbreuss.png","language":"PHP","readme":"# Notes Management Tool – REST-API\n\n[![Yii](https://img.shields.io/badge/Powered_by-Yii_Framework-green.svg?style=flat)](http://www.yiiframework.com/)\n\nThe REST-API for the Notes Management Tool.\n\nNote: This is the API only.\nYou need the appropriate client which is hosted at \u003chttps://github.com/tbreuss/notes-client\u003e.\n\n## Install\n\n    git clone https://github.com/tbreuss/notes-api.git\n    cd notes-api\n    composer install\n\n## Create/import database\n\nCreate a database at your hosting provider and import `config\\mysql-dump.sql`.\n\n## Config\n\nCopy configuration files:\n\n    cd config\n    cp db.dist.php db.php\n    cp params.dist.php params.php\n\nEdit both files according to your config settings. \n\n## Run\n\n    cd notes-server\n    php yii serve -p 8888\n\nOpen your webbrowser \u003chttp://localhost:8888/\u003e\n\nYou should see:\n\n    \u003cresponse\u003e\n        \u003ctitle\u003eREST-API for Notes Management Tool\u003c/title\u003e\n        \u003cinfo\u003eYou need an appropriate client to access this API\u003c/info\u003e\n        \u003cgithub\u003ehttps://github.com/tbreuss/notes-client\u003c/github\u003e\n        \u003curl\u003ehttps://notes.tebe.ch\u003c/url\u003e\n    \u003c/response\u003e\n\n## Build\n\n    composer build\n\nBuild a zip archive for production. Needs globally installed `git` and `composer` and an existing `config/prod.env.php`.\n\n          \n## Endpoints\n\nTo be done.\n\n### GET v1/ping\n\n### POST v1/login\n\n### GET v1/articles/\u003cid:\\d+\u003e\n\n### PUT v1/articles/\u003cid:\\d+\u003e\n\n### DELETE v1/articles/\u003cid:\\d+\u003e\n\n### GET v1/articles\n\n### POST v1/articles\n\n### GET v1/articles/latest\n\n### GET v1/articles/liked\n\n### GET v1/articles/modified\n\n### GET v1/articles/popular\n\n### POST v1/articles/upload\n\n### GET v1/users/\u003cid:\\d+\u003e\n\n### GET v1/users\n\n### GET v1/tags/\u003cid:\\d+\u003e\n\n### GET v1/tags\n\n### GET v1/tags/selected\n\n## cURL calls\n\nTo be done.\n\nPost login\n    \n    curl -i --header \"Content-Type: application/json\" --request POST --data '{\"username\":\"xyz\",\"password\":\"xyz\"}' http://localhost:8888/v1/login\n    curl -i --header \"Content-Type: application/json\" --request OPTIONS --data '{\"username\":\"xyz\",\"password\":\"xyz\"}' http://localhost:8888/v1/login\n    curl -i -X OPTIONS http://localhost:8888/ --header \"Content-Type: application/json\"\n","funding_links":[],"categories":[],"sub_categories":[],"project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Ftbreuss%2Fnotes-api","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Ftbreuss%2Fnotes-api","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Ftbreuss%2Fnotes-api/lists"}