From 96a71bfa42aef37d85cf155e119d3b02a2439ee0 Mon Sep 17 00:00:00 2001 From: Skylar Ittner Date: Wed, 28 Sep 2016 10:32:13 -0600 Subject: [PATCH] Add README.md --- README.md | 34 ++++++++++++++++++++++++ composer.json | 8 +++--- composer.lock | 0 database.php | 0 dieifnotloggedin.php | 0 getitem.php | 0 getlocation.php | 0 getmodel.php | 0 getstatus.php | 0 login.php | 0 nbproject/project.properties | 0 nbproject/project.xml | 0 readfrom.php | 0 required.php | 0 search.php | 0 updateitem.php | 0 vendor/autoload.php | 0 vendor/catfan/medoo/.gitattributes | 0 vendor/catfan/medoo/.gitignore | 0 vendor/catfan/medoo/LICENSE | 0 vendor/catfan/medoo/README.md | 0 vendor/catfan/medoo/composer.json | 0 vendor/catfan/medoo/medoo.php | 0 vendor/catfan/medoo/src/medoo-logo.png | Bin vendor/composer/ClassLoader.php | 0 vendor/composer/LICENSE | 0 vendor/composer/autoload_classmap.php | 0 vendor/composer/autoload_files.php | 0 vendor/composer/autoload_namespaces.php | 0 vendor/composer/autoload_psr4.php | 0 vendor/composer/autoload_real.php | 0 vendor/composer/autoload_static.php | 0 vendor/composer/installed.json | 0 33 files changed, 38 insertions(+), 4 deletions(-) create mode 100644 README.md mode change 100644 => 100755 composer.json mode change 100644 => 100755 composer.lock mode change 100644 => 100755 database.php mode change 100644 => 100755 dieifnotloggedin.php mode change 100644 => 100755 getitem.php mode change 100644 => 100755 getlocation.php mode change 100644 => 100755 getmodel.php mode change 100644 => 100755 getstatus.php mode change 100644 => 100755 login.php mode change 100644 => 100755 nbproject/project.properties mode change 100644 => 100755 nbproject/project.xml mode change 100644 => 100755 readfrom.php mode change 100644 => 100755 required.php mode change 100644 => 100755 search.php mode change 100644 => 100755 updateitem.php mode change 100644 => 100755 vendor/autoload.php mode change 100644 => 100755 vendor/catfan/medoo/.gitattributes mode change 100644 => 100755 vendor/catfan/medoo/.gitignore mode change 100644 => 100755 vendor/catfan/medoo/LICENSE mode change 100644 => 100755 vendor/catfan/medoo/README.md mode change 100644 => 100755 vendor/catfan/medoo/composer.json mode change 100644 => 100755 vendor/catfan/medoo/medoo.php mode change 100644 => 100755 vendor/catfan/medoo/src/medoo-logo.png mode change 100644 => 100755 vendor/composer/ClassLoader.php mode change 100644 => 100755 vendor/composer/LICENSE mode change 100644 => 100755 vendor/composer/autoload_classmap.php mode change 100644 => 100755 vendor/composer/autoload_files.php mode change 100644 => 100755 vendor/composer/autoload_namespaces.php mode change 100644 => 100755 vendor/composer/autoload_psr4.php mode change 100644 => 100755 vendor/composer/autoload_real.php mode change 100644 => 100755 vendor/composer/autoload_static.php mode change 100644 => 100755 vendor/composer/installed.json diff --git a/README.md b/README.md new file mode 100644 index 0000000..d63c20d --- /dev/null +++ b/README.md @@ -0,0 +1,34 @@ +Snipe-IT API +============ + +This is a simple API for accessing a Snipe-IT database. + + +Installing +---------- + +Installation is easy. Assuming you have a web server with PHP and a suitable +database driver, simply put all the files in this repo in a web-accessible +folder. + +Edit the file database.php and add the connection settings for your Snipe-IT +database. + +On the mobile app, enter the full address for the API server. Include +`http(s)://` and the trailing slash. + +The API can be put in a subfolder of the main Snipe-IT installation, but it can +also be setup on any server that can reach the database. + +Troubleshooting +--------------- + +If you have a problem: + +* Check you have the full path (with trailing slash) entered into the app. +* Install PHP Composer and run `composer install`. +* Check you can access the API from a computer. Go to the API folder/login.php. + You should see JSON with an error message "Missing username.". If you see + a different error, or there is no error, double-check the database settings, + and try installing Composer dependencies. +* If none of these solutions work, open an issue. \ No newline at end of file diff --git a/composer.json b/composer.json old mode 100644 new mode 100755 index dfcbc4c..1a2bc1b --- a/composer.json +++ b/composer.json @@ -1,10 +1,10 @@ { - "name": "vendor/snipe-i-t-mobile-a-p-i", - "description": "Description of project SnipeITMobileAPI.", + "name": "netsyms/snipeit-mobile-api", + "description": "Mobile API server for SnipeIT.", "authors": [ { - "name": "skylar", - "email": "your@email.here" + "name": "Skylar Ittner", + "email": "admin@netsyms.com" } ], "require": { diff --git a/composer.lock b/composer.lock old mode 100644 new mode 100755 diff --git a/database.php b/database.php old mode 100644 new mode 100755 diff --git a/dieifnotloggedin.php b/dieifnotloggedin.php old mode 100644 new mode 100755 diff --git a/getitem.php b/getitem.php old mode 100644 new mode 100755 diff --git a/getlocation.php b/getlocation.php old mode 100644 new mode 100755 diff --git a/getmodel.php b/getmodel.php old mode 100644 new mode 100755 diff --git a/getstatus.php b/getstatus.php old mode 100644 new mode 100755 diff --git a/login.php b/login.php old mode 100644 new mode 100755 diff --git a/nbproject/project.properties b/nbproject/project.properties old mode 100644 new mode 100755 diff --git a/nbproject/project.xml b/nbproject/project.xml old mode 100644 new mode 100755 diff --git a/readfrom.php b/readfrom.php old mode 100644 new mode 100755 diff --git a/required.php b/required.php old mode 100644 new mode 100755 diff --git a/search.php b/search.php old mode 100644 new mode 100755 diff --git a/updateitem.php b/updateitem.php old mode 100644 new mode 100755 diff --git a/vendor/autoload.php b/vendor/autoload.php old mode 100644 new mode 100755 diff --git a/vendor/catfan/medoo/.gitattributes b/vendor/catfan/medoo/.gitattributes old mode 100644 new mode 100755 diff --git a/vendor/catfan/medoo/.gitignore b/vendor/catfan/medoo/.gitignore old mode 100644 new mode 100755 diff --git a/vendor/catfan/medoo/LICENSE b/vendor/catfan/medoo/LICENSE old mode 100644 new mode 100755 diff --git a/vendor/catfan/medoo/README.md b/vendor/catfan/medoo/README.md old mode 100644 new mode 100755 diff --git a/vendor/catfan/medoo/composer.json b/vendor/catfan/medoo/composer.json old mode 100644 new mode 100755 diff --git a/vendor/catfan/medoo/medoo.php b/vendor/catfan/medoo/medoo.php old mode 100644 new mode 100755 diff --git a/vendor/catfan/medoo/src/medoo-logo.png b/vendor/catfan/medoo/src/medoo-logo.png old mode 100644 new mode 100755 diff --git a/vendor/composer/ClassLoader.php b/vendor/composer/ClassLoader.php old mode 100644 new mode 100755 diff --git a/vendor/composer/LICENSE b/vendor/composer/LICENSE old mode 100644 new mode 100755 diff --git a/vendor/composer/autoload_classmap.php b/vendor/composer/autoload_classmap.php old mode 100644 new mode 100755 diff --git a/vendor/composer/autoload_files.php b/vendor/composer/autoload_files.php old mode 100644 new mode 100755 diff --git a/vendor/composer/autoload_namespaces.php b/vendor/composer/autoload_namespaces.php old mode 100644 new mode 100755 diff --git a/vendor/composer/autoload_psr4.php b/vendor/composer/autoload_psr4.php old mode 100644 new mode 100755 diff --git a/vendor/composer/autoload_real.php b/vendor/composer/autoload_real.php old mode 100644 new mode 100755 diff --git a/vendor/composer/autoload_static.php b/vendor/composer/autoload_static.php old mode 100644 new mode 100755 diff --git a/vendor/composer/installed.json b/vendor/composer/installed.json old mode 100644 new mode 100755