-
Notifications
You must be signed in to change notification settings - Fork 0
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Merge branch 'main' of https://github.com/ptrosek/miniWMS
- Loading branch information
Showing
1 changed file
with
44 additions
and
1 deletion.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1 +1,44 @@ | ||
| # miniWMS | ||
| # 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: <b>Admin, Manager and Worker</b> | ||
| <br> | ||
| -<b>Admin</b> has a right to create new categories of goods, types of goods, warehouses, add new customers/suppliers and create new users. | ||
| <br> | ||
| -<b>Manager</b> 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. | ||
| <br> | ||
| -<b>Worker</b> 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. | ||
| <br> | ||
| For example <b>rec-213</b> would mean a record with a id of 213 | ||
|
|
||
| #### list of prefixes used. | ||
|
|
||
| -rec for record | ||
| <br> | ||
| -rei for receipt of goods | ||
| <br> | ||
| -iss for issue of goods | ||
| <br> | ||
| -mov for move action | ||
| <br> | ||
| -pos for position in the warehouse | ||
| <br> | ||
| -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. | ||
| <br> | ||
| After setting up the db server you need to export your username(as DB_USER_MWS) and password (as DB_PASS_MWS). | ||
| <br> | ||
| 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. | ||
| <br> | ||
| 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. | ||
| <br> | ||
| DO NOT DELETE ROWS FROM OPERATION_TYPE THIS WILL RESULT IN APPLICATION RAISING ERRORS. |