Browse Source

Add README.md

Skylar Ittner 2 years ago
parent
commit
96a71bfa42

+ 34
- 0
README.md View File

@@ -0,0 +1,34 @@
1
+Snipe-IT API
2
+============
3
+
4
+This is a simple API for accessing a Snipe-IT database.
5
+
6
+
7
+Installing
8
+----------
9
+
10
+Installation is easy.  Assuming you have a web server with PHP and a suitable 
11
+database driver, simply put all the files in this repo in a web-accessible 
12
+folder.
13
+
14
+Edit the file database.php and add the connection settings for your Snipe-IT 
15
+database.
16
+
17
+On the mobile app, enter the full address for the API server.  Include 
18
+`http(s)://` and the trailing slash. 
19
+
20
+The API can be put in a subfolder of the main Snipe-IT installation, but it can 
21
+also be setup on any server that can reach the database.
22
+
23
+Troubleshooting
24
+---------------
25
+
26
+If you have a problem:
27
+
28
+* Check you have the full path (with trailing slash) entered into the app.
29
+* Install PHP Composer and run `composer install`.
30
+* Check you can access the API from a computer.  Go to the API folder/login.php.
31
+  You should see JSON with an error message "Missing username.".  If you see 
32
+  a different error, or there is no error, double-check the database settings, 
33
+  and try installing Composer dependencies.
34
+* If none of these solutions work, open an issue.

+ 4
- 4
composer.json View File

@@ -1,10 +1,10 @@
1 1
 {
2
-    "name": "vendor/snipe-i-t-mobile-a-p-i",
3
-    "description": "Description of project SnipeITMobileAPI.",
2
+    "name": "netsyms/snipeit-mobile-api",
3
+    "description": "Mobile API server for SnipeIT.",
4 4
     "authors": [
5 5
         {
6
-            "name": "skylar",
7
-            "email": "your@email.here"
6
+            "name": "Skylar Ittner",
7
+            "email": "admin@netsyms.com"
8 8
         }
9 9
     ],
10 10
     "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