From 5112ed7d8b73387f7009e76e521c98cdddfaf010 Mon Sep 17 00:00:00 2001 From: ptrosek <80350895+ptrosek@users.noreply.github.com> Date: Mon, 29 Aug 2022 15:06:52 +0200 Subject: [PATCH] Updating readme --- README.md | 45 ++++++++++++++++++++++++++++++++++++++++++++- 1 file changed, 44 insertions(+), 1 deletion(-) diff --git a/README.md b/README.md index ba76de2..2a04098 100644 --- a/README.md +++ b/README.md @@ -1 +1,44 @@ -# miniWMS \ No newline at end of file +# miniWMS +miniWMS is a minimalistic WMS system with support for a barcode reader and a label creation function. +It's currently developed as a website based app using Flask. +## How to use +#### There are 3 types of users: Admin, Manager and Worker +
+-Admin has a right to create new categories of goods, types of goods, warehouses, add new customers/suppliers and create new users. +
+-Manager has a right to create a new receipt and issue of goods, and to create a move action. While creating this actions a manager has an option of choosing +a specific user to handle a task he creates or he can let users assign themselves. +
+-Worker and every aforementioned type of user has a right to lookup and handle tasks created by managers. + +#### How to read barcodes created by this system +Every barcode consists of 3 letter prefix and then variable size id. +
+For example rec-213 would mean a record with a id of 213 + +#### list of prefixes used. + +-rec for record +
+-rei for receipt of goods +
+-iss for issue of goods +
+-mov for move action +
+-pos for position in the warehouse +
+-typ for good type + +## How to install +To run to this app you need to deploy it any of the supported servers https://flask.palletsprojects.com/en/2.2.x/deploying/ +and also install mysql server and add the miniwms.sql schema to it. +
+After setting up the db server you need to export your username(as DB_USER_MWS) and password (as DB_PASS_MWS). +
+If your db server is not running as localhost or the schema your using is not named miniwms then you are welcome to change the code in lines 26-33. +
+When all of the install requierments are met then you can login using a default user with username: admin and password: admin +that you can delete manually from the database after creating your own admin user. +
+DO NOT DELETE ROWS FROM OPERATION_TYPE THIS WILL RESULT IN APPLICATION RAISING ERRORS.