Merge pull request #182 from inventree/app-updates

App updates

.gitignore

@@ -4,4 +4,6 @@ env/
 
 # Compiled python files
 *.pyd
-*.pyc
+*.pyc
+
+.vscode

docs/app/app.md

@@ -12,6 +12,14 @@ The InvenTree Mobile App brings stock control to your pocket. Integrating seamle
 
 Native barcode support provides a multitude of context-sensitive stock control actions, allowing streamlined inventory management at your fingertips. The app has been optimized for speed, providing instant access to stock knowledge and handy on-site functionality.
 
+## Features
+
+- View and edit part and stock information with a blazingly fast interface
+- Perform stock control actions on the go
+- Barcode integrations simply stock operations
+- Receive purchase orders and check in stock items
+- And many more!
+
 ## Download
 
 The InvenTree app can be downloaded from either the Android or Apple app stores, or accessed via the links below:

docs/app/connect.md

@@ -6,13 +6,18 @@ title: Connect to Server
 
 Use of the InvenTree app assumes that you (the user) have access to an InvenTree server.
 
-When first running the app, no profile has been configured. A message is displayed at the bottom of the screen, indicting that a server profile needs to be configured.
+When first running the app, no profile has been configured. The *server* icon in the top-right corner of the home screen is <span style='color: red'>red</span>, indicating that there is no connection to an InvenTree server:
 
-{% with id="no_server", url="app/initial_home_screen.jpg", maxheight="240px", description="No server configured" %}
+{% with id="no_server", url="app/initial.png", maxheight="240px", description="No server configured" %}
+{% include "img.html" %}
+{% endwith %}
+
+Press on the server icon to navigate to the server selection view:
+
+{% with id="no_profiles", url="app/no_profiles.png", maxheight="240px", description="No server configured" %}
 {% include "img.html" %}
 {% endwith %}
 
-Press on the mesage to navigate to the server selection view:
 
 ### Create Server
 
@@ -21,7 +26,7 @@ Press on the mesage to navigate to the server selection view:
 
 Press the <span class='fas fa-plus-circle blue'></span> button in the bottom-right corner of the screen to create a new server profile.
 
-{% with id="add_profile", url="app/add_server_profile.jpg", maxheight="240px", description="Add server" %}
+{% with id="add_profile", url="app/add_server_profile.png", maxheight="240px", description="Add server" %}
 {% include 'img.html' %}
 {% endwith %}
 
@@ -29,10 +34,10 @@ Enter the required server details:
 
 | Parameter | Description |
 | --- | --- |
-| Name | Name for the server profile (can be any value, simply for reference) |
-| Server | InvenTree server address (including port, if required). e.g. `http://inventree.myserver.com:8080` |
-| Username | Your account username (case sensitive) |
-| Password | Your account password (case sensitive) |
+| **Name** | Name for the server profile (can be any value, simply for reference) |
+| **Server** | InvenTree server address (including port, if required). e.g. `http://inventree.myserver.com:8080` |
+| **Username** | Your account username (case sensitive) |
+| **Password** | Your account password (case sensitive) |
 
 ### Connect to Server
 
@@ -62,15 +67,76 @@ To edit the server profile details, long press on the server profile, and select
 {% include 'img.html' %}
 {% endwith %}
 
-## Drawer Menu
+## Home Screen
 
-The *Drawer Menu* is accessible from all top-level app views, and provides quick access to important app features. To open the drawer menu, select the <span class='fas fa-bars'></span> icon in the top-left corner of the screen (where available).
+The app *home screen* provides quick-access buttons for stock view and actions:
 
-{% with id="drawer", url="app/drawer.jpg", maxheight="240px", description="Open drawer menu" %}
+{% with id="home", url="app/home.png", maxheight="240px", description="Home screen" %}
 {% include 'img.html' %}
 {% endwith %}
 
-The *Drawer Menu* provides instant access to the following views:
+### Scan Barcode
+
+Select the *Scan Barcode* icon to open the [barcode scanner](./barcode.md). Scan a barcode to navigate to a detail view for the item you have scanned.
+
+### Search
+
+Select the *Search* icon to open the InvenTree search window. Entering a search term will return multiple search results, as shown in the examples below:
+
+{% with id="search_1", url="app/search_1.png", maxheight="240px", description="Search results" %}
+{% include 'img.html' %}
+{% endwith %}
+
+{% with id="search_2", url="app/search_2.png", maxheight="240px", description="Search results" %}
+{% include 'img.html' %}
+{% endwith %}
+
+### Parts
+
+Select the *Parts* icon to open the [parts display](./part.md). This initially displays the top-level part category, showing information for parts and sub categories.
+
+### Starred Parts
+
+Selected the *Starred Parts* icon to show a list of parts you have personally marked as your "favorite" parts.
+
+### Stock
+
+Select the *Stock* icon to open the [stock display](./stock.md). This initially displays the top-level stock category, showing information for stock items and sub locations.
+
+### Purchase Orders
+
+Select the *Purchase Orders* icon to open the [purchase orders display](./po.md). This shows a list of currently outstanding purchase orders, allowing line items to be received into stock.
+
+### Suppliers
+
+Select the *Suppliers* icon to display the list of available suppliers
+
+### Manufacturers
+
+Select the *Manufacturers* icon to display the list of available manufacturers
+
+### Customers
+
+Select the *Customers* icon to display the list of available customers
+
+### Settings
+
+Select the *Settings* icon to open the [settings display](./settings.md)
+
+## Drawer Menu
+
+The *Drawer Menu* is a quick-access menu which is accessible from most display screens:
+
+{% with id="drawer", url="app/drawer.png", maxheight="240px", description="Open drawer menu" %}
+{% include 'img.html' %}
+{% endwith %}
+
+The *Drawer Menu* can be accessed in the following ways:
+
+- From the *Home Screen* select the *Drawer* icon in the top-left corner of the screen
+- From any other screen, long-press the *Back* button in the top-left corner of the screen
+
+The *Drawer Menu* provides instant access to the following actions:
 
 ### InvenTree
 
@@ -84,24 +150,7 @@ Select *Scan Barcode* to open the barcode scanner, and scan an InvenTree stock i
 
 Select *Search* to open a global search screen.
 
-### Parts
-
-Select *Parts* to navigate to the [Parts](./part.md) view.
-
-### Stock
-
-Select *Stock* to navigate to the [Stock](./stock.md) view.
-
 ### Settings
 
 Select *Settings* to navigate to the app [settings](./settings.md) menu.
 
-## Home Screen
-
-The app *home screen* provides quick-access buttons for stock view and actions.
-
-Additionally, the connection status of the server is displayed at the bottom of the screen.
-
-{% with id="home", url="app/home.jpg", maxheight="240px", description="Home screen" %}
-{% include 'img.html' %}
-{% endwith %}

docs/app/po.md

@@ -0,0 +1,49 @@
+---
+title: Purchase Orders
+---
+
+## Purchase Order List
+
+The purchase order list display shows all current *outstanding* purchase orders. (Purchase orders which have been completed are not shown here).
+
+{% with id="po_list", url="app/po_list.png", maxheight="240px", description="Purchase order list" %}
+{% include "img.html" %}
+{% endwith %}
+
+Select an individual purchase order to display the detail view for that order.
+
+### Filtering
+
+Available purchase orders can be subsequently filtered using the search input at the top of the screen
+
+## Purchase Order Detail
+
+{% with id="po_detail", url="app/po_detail.png", maxheight="240px", description="Purchase order details" %}
+{% include "img.html" %}
+{% endwith %}
+
+### Edit Order Details
+
+From the detail view, select the *Edit* button in the top-right of the screen. This opens the purchase order editing display:
+
+{% with id="edit_po", url="app/po_edit.png", maxheight="240px", description="Edit purchase order" %}
+{% include "img.html" %}
+{% endwith %}
+
+### Line Items
+
+The *Line Items* tab shows the line items associated with this purchase order:
+
+{% with id="po_lines", url="app/po_lines.png", maxheight="240px", description="Purchase order line items" %}
+{% include "img.html" %}
+{% endwith %}
+
+Long press on a particular line item to receive the item into stock.
+
+### Stock Items
+
+Once items have been received into stock against a particular purchase order, they are displayed in the *Stock Items* tab:
+
+{% with id="po_stock", url="app/po_stock.png", maxheight="240px", description="Purchase order stock items" %}
+{% include "img.html" %}
+{% endwith %}

docs/app/release.md

@@ -5,6 +5,22 @@ title: App Release Notes
 ## InvenTree App Release Notes
 ---
 
+### 0.5.0 - October 2021
+---
+
+- Major UI overhaul
+- Adds many more options to the home screen
+- Adds global "drawer" - accessible via long-press of the "back" button
+- Display Purchase Order details
+- Edit Purchase Order information
+- Adds ability to receive stock items against purchase orders
+- Display Company details (supplier / manufacturer / customer)
+- Edit Company information
+- Improvements to stock adjustment actions
+- Improvements to barcode scanning
+- Fixed bug relating to stock transfer for parts with specified "units"
+- Multiple other small bug fixes
+
 ### 0.4.7 - September 2021
 ---
 

docs/app/stock.md

@@ -107,6 +107,10 @@ The *actions* tab displays the available actions for the selected stock item:
 
 Select the *Count Stock* action to validate the current number of items in stock. Use this option to perform a quick stocktake!
 
+{% with id="stock-count", url="stock_count.png" %}
+{% include "app_img.html" %}
+{% endwith %}
+
 !!! info "Serialized Stock"
     The *count stock* action is not available for serialized stock items, as they have a fixed quantity of 1
 
@@ -114,13 +118,25 @@ Select the *Count Stock* action to validate the current number of items in stock
 
 Select this action to remove a certain quantity from the selected stock item. For example, if there are 12 items available, and you take 3 items, the listed quantity will be reduced to 9 itemes.
 
+{% with id="stock-remove", url="stock_remove.png" %}
+{% include "app_img.html" %}
+{% endwith %}
+
 #### Add Stock
 
 Select this action to add a certain quantity to the selected stock item. For example, if there are 12 items available, and you add 3 items, the listed quantity will be increased to 15 items.
 
+{% with id="stock-add", url="stock_add.png" %}
+{% include "app_img.html" %}
+{% endwith %}
+
 #### Transfer Stock
 
-Transfer (move) the stock item to a new location
+Transfer (move) the stock item to a new location:
+
+{% with id="stock-transfer", url="stock_transfer.png" %}
+{% include "app_img.html" %}
+{% endwith %}
 
 #### Scan Into Location
 

mkdocs.yml

@@ -115,6 +115,7 @@ nav:
     - Barcodes: app/barcode.md
     - Parts: app/part.md
     - Stock: app/stock.md
+    - Purchase Orders: app/po.md
     - Settings: app/settings.md
     - Privacy: app/privacy.md
     - Release Notes: app/release.md