intials app
This commit is contained in:
7
lstDocs/docs/install-extras/_category_.json
Normal file
7
lstDocs/docs/install-extras/_category_.json
Normal file
@@ -0,0 +1,7 @@
|
||||
{
|
||||
"label": "Install",
|
||||
"position": 3,
|
||||
"link": {
|
||||
"type": "generated-index"
|
||||
}
|
||||
}
|
||||
11
lstDocs/docs/install-extras/iis.md
Normal file
11
lstDocs/docs/install-extras/iis.md
Normal file
@@ -0,0 +1,11 @@
|
||||
---
|
||||
sidebar_position: 2
|
||||
---
|
||||
|
||||
# Runing in IIS (Internet Information Services)
|
||||
|
||||
This is the Approved way of running via windows and utlizing HTTPS
|
||||
|
||||
This process is optional and not needed to run the app.
|
||||
|
||||
Please note that if you plan to utlize the scanner app you must use IIS to run as PWA apps requires ssl
|
||||
BIN
lstDocs/docs/install-extras/img/terminal.png
Normal file
BIN
lstDocs/docs/install-extras/img/terminal.png
Normal file
Binary file not shown.
|
After Width: | Height: | Size: 57 KiB |
61
lstDocs/docs/install-extras/services.md
Normal file
61
lstDocs/docs/install-extras/services.md
Normal file
@@ -0,0 +1,61 @@
|
||||
---
|
||||
sidebar_position: 1
|
||||
---
|
||||
|
||||
# Run as a service
|
||||
|
||||
To run LST as a serive there are 2 options to accomplish this
|
||||
|
||||
## Install
|
||||
|
||||
Utlizing the powershell script that is in the scripts folder
|
||||
|
||||
Open vscode once again or clear the termnial if you still have it open.
|
||||
|
||||
Next run the code below.
|
||||
|
||||
```bash
|
||||
.\scripts\services.ps1 -serviceName "LST_app" -option "install" -appPath "E:\LST" -description "Logistics Support Tool" -command "run start"
|
||||
```
|
||||
|
||||
This will
|
||||
|
||||
- Create a windows service using NSSM and call it LST_app
|
||||
- It will also set the restart policy to restart 3 times
|
||||
- It will depend on MSQLServer to make sure this is up and running before we try to connect to it
|
||||
- It will start the node app
|
||||
- And Lastly will set it to auto start once the server comes up.
|
||||
|
||||
## Stop the Service
|
||||
|
||||
To stop the service you can utilize the same script
|
||||
|
||||
```bash
|
||||
.\scripts\services.ps1 -serviceName "LST_app" -option "stop" -appPath "E:\LST"
|
||||
```
|
||||
|
||||
This will completely stop the service and you will need to start it
|
||||
|
||||
## Start the Service
|
||||
|
||||
Yet again utlizeing the same script
|
||||
|
||||
```bash
|
||||
.\scripts\services.ps1 -serviceName "LST_app" -option "start" -appPath "E:\LST"
|
||||
```
|
||||
|
||||
## Deleteing the Service
|
||||
|
||||
This will compeltely remove the service from the server
|
||||
|
||||
```bash
|
||||
.\scripts\services.ps1 -serviceName "LST_app" -option "delete" -appPath "E:\LST"
|
||||
```
|
||||
|
||||
## Restart
|
||||
|
||||
This will stop the service wait 2 seconds and restart the service
|
||||
|
||||
```bash
|
||||
.\scripts\services.ps1 -serviceName "LST_app" -option "restart" -appPath "E:\LST"
|
||||
```
|
||||
154
lstDocs/docs/install.md
Normal file
154
lstDocs/docs/install.md
Normal file
@@ -0,0 +1,154 @@
|
||||
---
|
||||
sidebar_position: 2
|
||||
---
|
||||
|
||||
# Install Process
|
||||
|
||||
Get the latest build **From Azure**.
|
||||
|
||||
<!-- Or **try Docusaurus immediately** with **[docusaurus.new](https://docusaurus.new)**. -->
|
||||
|
||||
### What you'll need
|
||||
|
||||
- [Node.js](https://nodejs.org/en/download/) version 22.18 or above:
|
||||
|
||||
- When installing Node.js, you are recommended to check all checkboxes related to dependencies.
|
||||
|
||||
- [VS Code](https://code.visualstudio.com/download):
|
||||
|
||||
- If you plant to contribute or need to tweak some data this is the recommended editor.
|
||||
- During the app install updates and minor changes we will always be refering to VScode
|
||||
|
||||
- [Notepad ++](https://notepad-plus-plus.org/);
|
||||
|
||||
- An alternate solution to doing minor edits to the app including changes to the .env file
|
||||
|
||||
- [NSSM](https://nssm.cc/);
|
||||
|
||||
- This is used to create the services and required to be in the root of the app.
|
||||
|
||||
- [Postgres](https://www.postgresql.org/download/);
|
||||
- This is the DB of choice.
|
||||
|
||||
## Creating the app
|
||||
|
||||
Create a new directory where all you will host the app recommeneded
|
||||
|
||||
```bash
|
||||
E:\LST
|
||||
```
|
||||
|
||||
Extract the build you downloaded from the repo.
|
||||
|
||||
You should see something similar to
|
||||
|
||||
```bash
|
||||
LST/
|
||||
├── .vscode/ # vscode settings to match across all developers/contributors
|
||||
│ ├── settings.json
|
||||
├── dist # Main backend
|
||||
│ ├── internal
|
||||
│ ├── db
|
||||
│ ├── main.js
|
||||
├── frontend/
|
||||
│ ├── dist # Frontend app
|
||||
├── lstDocs/
|
||||
│ ├── build # Docs on the entire app
|
||||
├── lstWrapper/
|
||||
│ │ ├── LastWrapper.exe
|
||||
│ │ ├── LstWRapper.dll
|
||||
│ │ ├── webconfig.xml
|
||||
│ │ ├── several other files related to the wrapper
|
||||
├── scripts/
|
||||
│ │ ├── services.ps1 #service controler
|
||||
├── .env-example
|
||||
├── nssm.exe
|
||||
├── package.json
|
||||
├── package-lock.json
|
||||
├── README.md
|
||||
├── CHANGELOG.md
|
||||
```
|
||||
|
||||
## Doing the intial setup
|
||||
|
||||
Make sure you have installed both
|
||||
|
||||
- VScode
|
||||
- Node
|
||||
|
||||
### Installing dep
|
||||
|
||||
open the app in vs code
|
||||
open terminal
|
||||
|
||||

|
||||
|
||||
run the install command
|
||||
|
||||
```bash
|
||||
npm run install
|
||||
```
|
||||
|
||||
### Creating the env
|
||||
|
||||
Create a copy of the .env-example file and rename it .env
|
||||
|
||||
Please review all comments in the env file to make sure you are only change what is needed to be change.
|
||||
|
||||
```bash
|
||||
# server port - should only be changed if you really need this changed as its linked to the wrapper
|
||||
VITE_PORT=4000
|
||||
|
||||
# TMS AccoutINFO - This is for Transport Insight only
|
||||
USERID=ALPLAWS
|
||||
PASSWORD=password
|
||||
REQUESTUSER="ALPLAIMPORT"
|
||||
|
||||
# logLevel
|
||||
LOG_LEVEL=debug
|
||||
|
||||
# alpaprod tec apiKey
|
||||
TEC_API_KEY = "api key"
|
||||
|
||||
# postgres db
|
||||
DB_HOST=localhost
|
||||
DB_PORT=5433
|
||||
DB_USER=username
|
||||
DB_PASSWORD=superSecretPassword
|
||||
DB_NAME=lst_db
|
||||
|
||||
```
|
||||
|
||||
### DB setup
|
||||
|
||||
Make sure you have installed Postrgres, and recommended to install PGAdmin
|
||||
|
||||
After the install is completed please open PGAdmin and login with
|
||||
|
||||
Create a new database and call it lst_db.
|
||||
|
||||
NOTE\* You can change the db name you just need to match it to the same as name as you have set in the .env file
|
||||
|
||||
back in the termnial run the following command
|
||||
|
||||
```bash
|
||||
npm run db:migrate
|
||||
```
|
||||
|
||||
### First Startup
|
||||
|
||||
Last step before moveing over to running as a service and running in iis please start up by running the below
|
||||
|
||||
```bash
|
||||
npm start
|
||||
```
|
||||
|
||||
As this is the first time you will see a lot of logs and eventually see the system say Running.
|
||||
Please visit
|
||||
[http://localhost:4000](http://localhost:4000/)
|
||||
to validate everything is running and create the intial user
|
||||
by going to [Register](http://localhost:4000/register).
|
||||
|
||||
Please note the first user created is the system admin user, after created you will be able to login and change settings and activate features, as most features are disabled by default.
|
||||
|
||||
once you are ready to set this up and leave it head over to [Setting up As Service](/docs/install-extras/services)
|
||||
64
lstDocs/docs/intro.md
Normal file
64
lstDocs/docs/intro.md
Normal file
@@ -0,0 +1,64 @@
|
||||
---
|
||||
sidebar_position: 1
|
||||
---
|
||||
|
||||
# Logisitcs Support Tool Intro
|
||||
|
||||
## What is lst
|
||||
|
||||
Lst is a logistics support tool, and aid to ALPLAprod
|
||||
|
||||
All data in here is just to be treated as an aid and can still be completed manually in alplaprod.
|
||||
|
||||
These docs are here to help show what LST has to offer as well as the manual process via alpla prod.
|
||||
|
||||
## What dose LST offer
|
||||
|
||||
- One click print
|
||||
- Controls printing of labels
|
||||
- devices that can be used
|
||||
- Printer control
|
||||
- plc contorl
|
||||
- ame palletizer control
|
||||
- considers more busness logic than alplaprod
|
||||
- enough mateial is needed in the system to create the next pallet
|
||||
- this will be the same for packaging as well.
|
||||
- special processes
|
||||
- inhouse delivery triggered once booked in
|
||||
- stop gap on printing labels at specific times
|
||||
- per line delay in printing
|
||||
- Silo adjustments
|
||||
- Silo adjustments per lines with trends
|
||||
- Attach silo
|
||||
- Only shows machines not attached to this silo
|
||||
- Detach silo
|
||||
- Only shows machiens that are attached to the silo.
|
||||
- TMS intergration
|
||||
- inergration with TI to auto add in orders
|
||||
- orders are based on a time defined per plant.
|
||||
- carriers can be auto set
|
||||
- Notifications
|
||||
- New blocking orders
|
||||
- materials out
|
||||
- downtime checks
|
||||
- reprint labels
|
||||
- Datamart
|
||||
- querys that can be pulled via excel
|
||||
- querys are created to make plants more easy if the data is not accesable in AlplaMart currently
|
||||
- Fake EDI (Demand management)
|
||||
- Orders in (standard template)
|
||||
- Customer specfic orders templates per plant
|
||||
- Forecast (standard Template)
|
||||
- Customer specfic forecast per plant
|
||||
- ocme intergration
|
||||
- customer shipping data
|
||||
- auto cycle counts
|
||||
- Updater
|
||||
- an updater built in for the app
|
||||
- can be set to pull nightly
|
||||
- manual updates can be ran as well
|
||||
- System
|
||||
- Remote restarts
|
||||
- Remote stops
|
||||
- Remote starts
|
||||
- Remote live logging
|
||||
Reference in New Issue
Block a user