Browse Source

Add README.md

master
Skylar Ittner 3 years ago
parent
commit
96a71bfa42

+ 34
- 0
README.md View File

@@ -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.

+ 4
- 4
composer.json View File

@@ -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": {

+ 0
- 0
composer.lock View File


+ 0
- 0
database.php View File


+ 0
- 0
dieifnotloggedin.php View File


+ 0
- 0
getitem.php View File


+ 0
- 0
getlocation.php View File


+ 0
- 0
getmodel.php View File


+ 0
- 0
getstatus.php View File


+ 0
- 0
login.php View File


+ 0
- 0
nbproject/project.properties View File


+ 0
- 0
nbproject/project.xml View File


+ 0
- 0
readfrom.php View File


+ 0
- 0
required.php View File


+ 0
- 0
search.php View File


+ 0
- 0
updateitem.php View File


+ 0
- 0
vendor/autoload.php View File


+ 0
- 0
vendor/catfan/medoo/.gitattributes View File


+ 0
- 0
vendor/catfan/medoo/.gitignore View File


+ 0
- 0
vendor/catfan/medoo/LICENSE View File


+ 0
- 0
vendor/catfan/medoo/README.md View File


+ 0
- 0
vendor/catfan/medoo/composer.json View File


+ 0
- 0
vendor/catfan/medoo/medoo.php View File


+ 0
- 0
vendor/catfan/medoo/src/medoo-logo.png View File


+ 0
- 0
vendor/composer/ClassLoader.php View File


+ 0
- 0
vendor/composer/LICENSE View File


+ 0
- 0
vendor/composer/autoload_classmap.php View File


+ 0
- 0
vendor/composer/autoload_files.php View File


+ 0
- 0
vendor/composer/autoload_namespaces.php View File


+ 0
- 0
vendor/composer/autoload_psr4.php View File


+ 0
- 0
vendor/composer/autoload_real.php View File


+ 0
- 0
vendor/composer/autoload_static.php View File


+ 0
- 0
vendor/composer/installed.json View File


Loading…
Cancel
Save