{"id":26341809,"url":"https://github.com/devsdenepal/readnrite","last_synced_at":"2026-01-03T03:46:46.763Z","repository":{"id":205569852,"uuid":"714328447","full_name":"devsdenepal/readnrite","owner":"devsdenepal","description":null,"archived":false,"fork":false,"pushed_at":"2023-11-18T10:20:49.000Z","size":1298,"stargazers_count":1,"open_issues_count":0,"forks_count":0,"subscribers_count":1,"default_branch":"main","last_synced_at":"2023-11-18T11:25:15.528Z","etag":null,"topics":[],"latest_commit_sha":null,"homepage":"http://devsdenepal.me/readnrite/","language":"HTML","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"gpl-2.0","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/devsdenepal.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}},"created_at":"2023-11-04T15:32:53.000Z","updated_at":"2023-11-18T10:21:09.000Z","dependencies_parsed_at":"2023-11-05T10:32:37.388Z","dependency_job_id":"541c5140-b494-4f68-b983-4f1ccb5f106b","html_url":"https://github.com/devsdenepal/readnrite","commit_stats":null,"previous_names":["devsdenepal/readnrite"],"tags_count":0,"template":null,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/devsdenepal%2Freadnrite","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/devsdenepal%2Freadnrite/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/devsdenepal%2Freadnrite/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/devsdenepal%2Freadnrite/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/devsdenepal","download_url":"https://codeload.github.com/devsdenepal/readnrite/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":243826776,"owners_count":20354220,"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":[],"created_at":"2025-03-16T04:44:45.442Z","updated_at":"2026-01-03T03:46:46.722Z","avatar_url":"https://github.com/devsdenepal.png","language":"HTML","funding_links":[],"categories":[],"sub_categories":[],"readme":"# Readn(W)rite API\r\n```\r\nReadnrite API is built to interact with Readnrite \r\n```\r\n## API Features\r\n\r\n- [`createAccount`](#createAccount)\r\n- [`edit_user`](#edit_user)\r\n- [`getUser`](#getUser)\r\n- [`createPage`](#createPage)\r\n- [`getPageList`](#getPageList)\r\n- [`getPage`](#getPage)\r\n- [`edit_page`](#edit_Page)\r\n- [`refresh_key`](#refresh_key)\r\n\r\n## Installation\r\n\u003e git clone https://github.com/devsdenepal/readnrite.git\r\n\r\n## Requirements\r\n- PHP Version: 8.2.4\r\n- Server (Backend): 10.4.28-MariaDB\r\n\r\n## Setup\r\n- Create databse : readnrite\r\n- Import table SQL from `sample/sql/`\r\n- Start all service/server from your c.panel (xampp suggested for study purpose)\r\n\r\n## API Functions\r\n\u003ctable\u003e\r\n\u003ctr\u003e\r\n\u003ctd\u003eFunction\u003c/td\u003e\r\n\u003ctd\u003eDescription\u003c/td\u003e\r\n\u003ctd\u003eParams\u003c/td\u003e\r\n\u003ctd\u003eReturns\u003c/td\u003e\r\n\u003c/tr\u003e\r\n\u003ctr id=\"createAccount\"\u003e\r\n\u003ctd\u003e\u003ccode\u003ecreateAccount\u003c/code\u003e\u003c/td\u003e\r\n\u003ctd\u003ecreate readnrite account \u003c/td\u003e\r\n\u003ctd\u003e\u003ccode\u003eshort_name\u003c/code\u003e, \u003ccode\u003eauthor_name\u003c/code\u003e\u003c/td\u003e\r\n\u003ctd\u003e\u003ccode\u003eshort_name\u003c/code\u003e, \u003ccode\u003eauthor_name\u003c/code\u003e, \u003ccode\u003edate_created\u003c/code\u003e, \u003ccode\u003euser_id\u003c/code\u003e, \u003ccode\u003euser_key\u003c/code\u003e\u003c/td\u003e \r\n\u003c/tr\u003e\r\n\u003ctr id=\"createPage\"\u003e\r\n\u003ctd\u003e\u003ccode\u003ecreatePage\u003c/code\u003e\u003c/td\u003e\r\n\u003ctd\u003ecreate readnrite page \u003c/td\u003e\r\n\u003ctd\u003e\u003ccode\u003eauthor_name\u003c/code\u003e, \u003ccode\u003etitle\u003c/code\u003e, \u003ccode\u003econtent\u003c/code\u003e, \u003ccode\u003euser_id\u003c/code\u003e, \u003ccode\u003e user_key\u003c/code\u003e\u003c/td\u003e\r\n\u003ctd\u003e \u003ccode\u003etitle\u003c/code\u003e, \u003ccode\u003edescription\u003c/code\u003e, \u003ccode\u003econtent\u003c/code\u003e, \u003ccode\u003edate_created\u003c/code\u003e, \u003ccode\u003epage_id\u003c/code\u003e, \u003ccode\u003epage_url\u003c/code\u003e\u003c/td\u003e \r\n\u003c/tr\u003e\r\n\u003ctr id=\"edit_Page\"\u003e\r\n\u003ctd\u003e\u003ccode\u003eeditPage\u003c/code\u003e\u003c/td\u003e\r\n\u003ctd\u003eedit readnrite page \u003c/td\u003e\r\n\u003ctd\u003e\u003ccode\u003eauthor_name\u003c/code\u003e, \u003ccode\u003etitle\u003c/code\u003e, \u003ccode\u003econtent\u003c/code\u003e, \u003ccode\u003e user_key\u003c/code\u003e\u003c/td\u003e\r\n\u003ctd\u003e\u003ccode\u003etitle\u003c/code\u003e, \u003ccode\u003econtent\u003c/code\u003e, \u003ccode\u003epage_description\u003c/code\u003e, \u003ccode\u003edate_created\u003c/code\u003e, \u003ccode\u003epage_id\u003c/code\u003e, \u003ccode\u003epage_url\u003c/code\u003e\u003c/td\u003e \r\n\u003c/tr\u003e\r\n\u003ctr id=\"edit_user\"\u003e\r\n\u003ctd\u003e\u003ccode\u003eedit_user\u003c/code\u003e\u003c/td\u003e\r\n\u003ctd\u003eedit readnrite account \u003c/td\u003e\r\n\u003ctd\u003e\u003ccode\u003eshort_name\u003c/code\u003e, \u003ccode\u003eauthor_name\u003c/code\u003e, \u003ccode\u003e user_key\u003c/code\u003e\u003c/td\u003e\r\n\u003ctd\u003e\u003ccode\u003eshort_name\u003c/code\u003e, \u003ccode\u003eauthor_name\u003c/code\u003e, \u003ccode\u003euser_id\u003c/code\u003e\u003c/td\u003e \r\n\u003c/tr\u003e\r\n\u003ctr id=\"getPage\"\u003e\r\n\u003ctd\u003e\u003ccode\u003egetPage\u003c/code\u003e\u003c/td\u003e\r\n\u003ctd\u003ecreate readnrite account \u003c/td\u003e\r\n\u003ctd\u003e\u003ccode\u003epage_id\u003c/code\u003e, \u003ccode\u003euser_key\u003c/code\u003e\u003c/td\u003e\r\n\u003ctd\u003e\u003ccode\u003etitle\u003c/code\u003e, \u003ccode\u003econtent\u003c/code\u003e, \u003ccode\u003epage_description\u003c/code\u003e, \u003ccode\u003edate_created\u003c/code\u003e, \u003ccode\u003epage_id\u003c/code\u003e, \u003ccode\u003epage_url\u003c/code\u003e,\u003ccode\u003e page_url\u003c/code\u003e\u003ccode\u003eviews\u003c/code\u003e\u003c/td\u003e \r\n\u003c/tr\u003e\r\n\u003ctr  id=\"getPageList\"\u003e\r\n\u003ctd\u003e\u003ccode\u003egetPageList\u003c/code\u003e\u003c/td\u003e\r\n\u003ctd\u003eget list of pages authored by the user \u003c/td\u003e\r\n\u003ctd\u003e\u003ccode\u003euser_id\u003c/code\u003e\u003c/td\u003e\r\n\u003ctd\u003e\u003ccode\u003etitle\u003c/code\u003e, \u003ccode\u003econtent\u003c/code\u003e, \u003ccode\u003epage_description\u003c/code\u003e, \u003ccode\u003edate_created\u003c/code\u003e, \u003ccode\u003epage_id\u003c/code\u003e, \u003ccode\u003epage_url\u003c/code\u003e,\u003ccode\u003e page_url\u003c/td\u003e \u003c/td\u003e \r\n\u003c/tr\u003e\r\n\u003ctr  id=\"getUser\"\u003e\r\n\u003ctd\u003e\u003ccode\u003egetUser\u003c/code\u003e\u003c/td\u003e\r\n\u003ctd\u003eget information about readnrite account \u003c/td\u003e\r\n\u003ctd\u003e\u003ccode\u003euser_id\u003c/code\u003e\u003c/td\u003e\r\n\u003ctd\u003e\u003ccode\u003eshort_name\u003c/code\u003e, \u003ccode\u003eauthor_name\u003c/code\u003e, \u003ccode\u003edate_created\u003c/code\u003e, \u003ccode\u003edate_created\u003c/code\u003e, \u003ccode\u003epages_authored\u003c/code\u003e\u003c/td\u003e \r\n\u003c/tr\u003e\r\n\u003ctr id=\"refresh_key\"\u003e\r\n\u003ctd\u003e\u003ccode\u003erefresh_key\u003c/code\u003e\u003c/td\u003e\r\n\u003ctd\u003eregenerate \u003ccode\u003euser_key\u003c/code\u003e\u003c/td\u003e\r\n\u003ctd\u003e\u003ccode\u003euser_key\u003c/code\u003e (old)\u003c/td\u003e\r\n\u003ctd\u003e\u003ccode\u003euser_key\u003c/code\u003e (new)\r\n\u003c/tr\u003e\r\n\u003c/table\u003e","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fdevsdenepal%2Freadnrite","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fdevsdenepal%2Freadnrite","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fdevsdenepal%2Freadnrite/lists"}