Skip to content

My Workflow Engine Server for node.js with GraphQL.

License

Notifications You must be signed in to change notification settings

MWarCZ/MWEServer

Repository files navigation

MWEServer

My Workflow Engine Server

Manuál

Manuál k systému MWE je k nalezení zde.

Zprovoznění

Prerekvizity

  • Operační systém
    • Linux
    • WSL či WSL 2 pro Windows 10
  • Node.js verze 11 a vyšší
    • Testováno na verzích: v11.15.0, v12.16.1
  • Databáze s podporou MySQL
    • Testováno na verzích: MariaDB 10.1.43, MariaDB 10.1.45
  • Yarn
    • Je doporučeno používat Yarn
    • Yarn byl aktivně využíván při vývoji
    • Neměl by být problém použít npm

Začínáme

  1. Instalace všech závislostí
yarn
# nebo
npm install
  1. Nastavení serveru GraphQL
  2. Nastavení připojení k databázi.
  3. Kompilace a sestavení distribuce.
yarn build
# nebo
npm run build
  1. První start serveru
    • Dojde k vymazání a synchronizaci schématu databáze, nahrání výchozích dat a spuštení serveru.
yarn start:first
# nebo
npm run start:first
# nebo je možné nahradit sekvencí
yarn setup:db # Smazání a synchronizace schématu databáze
yarn loag:ugm # Nahrání výchozích dat (Uživatelů, skupin, členství)
yarn start # Spustění produkční verze serveru

Odlehčení pro dlouhodobé nasazení

Pro dlouhodobější nasazení na serveru je možné zmenšit velikost adresáře node_modules.

  1. Projít celý postup Začínáme
  2. Smazat adresáře node_modules
yarn clean:node
  1. Nainstalovat jen nezbytné závislosti pro provoz
yarn --prod --link-duplicates
  1. Spustit server
yarn start

Použití dalších užitečných skriptů

  • Automatizované testy
# Pokud jsou v databázi nějaká produkční data, 
# tak je nutné nejprve vyčistit databázi
yarn setup:db # Smazání a synchronizace schématu databáze
yarn test # Spustění testů
yarn test:cov # Spuštění testů včetně generování pokrytí
  • Úprava kódu
yarn lint # Jen kontrola
yarn lint:fix # Oprava
yarn test:lint --fix # Oprava 
  • Rychlé spuštění serveru při vývoji ze souborů *.ts
yarn serve:gql # Spustí sever GraphQL 
yarn serve:runner # Spustí běhové jádro BPMN
  • Čištění
yarn build:clean # Vymaže složku distribuce
yarn test:clean # Vymaže složku testu pokrití 
yarn clean # Vymaže složky distribuce a testu pokrití
yarn clean:node # Vymaže složku s nainstalovanými balíčky
yarn clean:all # Spustí všechny čistící skripty