https://github.com/devsdenepal/readnrite
https://github.com/devsdenepal/readnrite
Last synced: 6 months ago
JSON representation
- Host: GitHub
- URL: https://github.com/devsdenepal/readnrite
- Owner: devsdenepal
- License: gpl-2.0
- Created: 2023-11-04T15:32:53.000Z (over 2 years ago)
- Default Branch: main
- Last Pushed: 2023-11-18T10:20:49.000Z (over 2 years ago)
- Last Synced: 2023-11-18T11:25:15.528Z (over 2 years ago)
- Language: HTML
- Homepage: http://devsdenepal.me/readnrite/
- Size: 1.24 MB
- Stars: 1
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# Readn(W)rite API
```
Readnrite API is built to interact with Readnrite
```
## API Features
- [`createAccount`](#createAccount)
- [`edit_user`](#edit_user)
- [`getUser`](#getUser)
- [`createPage`](#createPage)
- [`getPageList`](#getPageList)
- [`getPage`](#getPage)
- [`edit_page`](#edit_Page)
- [`refresh_key`](#refresh_key)
## Installation
> git clone https://github.com/devsdenepal/readnrite.git
## Requirements
- PHP Version: 8.2.4
- Server (Backend): 10.4.28-MariaDB
## Setup
- Create databse : readnrite
- Import table SQL from `sample/sql/`
- Start all service/server from your c.panel (xampp suggested for study purpose)
## API Functions
Function
Description
Params
Returns
createAccount
create readnrite account
short_name, author_name
short_name, author_name, date_created, user_id, user_key
createPage
create readnrite page
author_name, title, content, user_id, user_key
title, description, content, date_created, page_id, page_url
editPage
edit readnrite page
author_name, title, content, user_key
title, content, page_description, date_created, page_id, page_url
edit_user
edit readnrite account
short_name, author_name, user_key
short_name, author_name, user_id
getPage
create readnrite account
page_id, user_key
title, content, page_description, date_created, page_id, page_url, page_urlviews
getPageList
get list of pages authored by the user
user_id
title, content, page_description, date_created, page_id, page_url, page_url
getUser
get information about readnrite account
user_id
short_name, author_name, date_created, date_created, pages_authored
refresh_key
regenerate user_key
user_key (old)
user_key (new)