Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/ace411/fauxton-client
A simple CouchDB interaction library.
https://github.com/ace411/fauxton-client
async-php couch-database couchdb couchdb-client couchdb-mango fauxton fauxton-client functional-programming nosql php php-library php7 reactphp reactphp-components
Last synced: about 2 months ago
JSON representation
A simple CouchDB interaction library.
- Host: GitHub
- URL: https://github.com/ace411/fauxton-client
- Owner: ace411
- License: mit
- Created: 2017-02-18T11:57:29.000Z (almost 8 years ago)
- Default Branch: master
- Last Pushed: 2019-02-07T06:04:42.000Z (almost 6 years ago)
- Last Synced: 2024-10-11T02:47:50.911Z (2 months ago)
- Topics: async-php, couch-database, couchdb, couchdb-client, couchdb-mango, fauxton, fauxton-client, functional-programming, nosql, php, php-library, php7, reactphp, reactphp-components
- Language: PHP
- Size: 1.37 MB
- Stars: 9
- Watchers: 3
- Forks: 1
- Open Issues: 2
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# fauxton-client
A simple CouchDB interaction library.
## Requirements
- PHP 7.0+
## Installation
fauxton-client is available on Packagist. To install it, type the following on your preferred
command-line interface:
```
composer require chemem/fauxton-client dev-master
```
## Fauxton
Fauxton, formerly Futon, is the name of the Couch Database web client. Like its predecessor, Fauxton
is a robust web interface designed to ease interactions with CouchDB.
## The client
Fauxton-client is a PHP library written for the sole purpose of performing CouchDB operations such as
creating databases, creating indexes and writing Mango queries.
## NoSQL vs SQL
Structured Query Language (SQL) is a popular approach to handling back-end information and follows
Atomicity Consistency Isolation and Durability (ACID) conventions. Simply put, SQL databases allow
those who use them to store unique data in relational, table structures.
NoSQL, on the other hand, presents a different paradigm to handling data interactions:
NoSQL standards are a manifestation of Basically Available Soft-state Eventually consistent (BASE) practices.
Couch Database is a NoSQL database that follows a document-oriented, key-value pair format
that is also convenient for manipulating data.
## Documentation
I advise that you read the [official CouchDB documentation](http://docs.couchdb.org/en/2.0.0/api/index.html)
so as to better understand the fauxton-client. Also, reading the [fauxton-client wiki](https://github.com/ace411/fauxton-client/wiki/Introduction) is recommended
and therefore, prudent.
## Running the unit tests
In order to run the unit tests, run the following command:
```
vendor/bin/phpunit -c phpunit.xml.dist
```
## Dealing with problems
Endeavor to create an issue on GitHub when the need arises or send an email to [email protected]
## Note
In light of recent modification activity, the fauxton-client is temporarily unusable.