mozardbv/office-addin-react

Office web add-in voor Mozard

• Meld een bevinding
• Verzoek nieuwe functionaliteit

Inhoudsopgave

• mozardbv/office-addin-react
  • Inhoudsopgave
  • Over dit project
  • Aan de slag
    • Afhankelijkheden
    • Installatie
  • Tests draaien
    • Coding style tests
    • Manifestvalidatie
  • Deployment
    • Bouwen voor productie
  • Gebouwd met
  • Bijdragen
  • Versioning
  • Auteurs
  • Licentie

Over dit project

Zie ook: Office add-in documentation

Aan de slag

Afhankelijkheden

• nodejs >= 14.2
• Microsoft Office

Installatie

Clone dit git repository:

git clone git@gitlab.com:MozardBV/mozard-css.git

Haal lokale node modules binnen. Let op, dit werkt niet met yarn, aangezien deze niet goed omgaat met CRLF line endings. Zie GitHub Issue

npm install

Start de add-in:

npm run start
# of
npm run start:desktop
# of
npm run start:web

Het kan zijn dat door een bug de devserver niet automatisch start, is dat het geval, start deze dan met:

npm run dev-server

Om te stoppen:

npm run stop

Je kan op meerdere manieren lokaal ontwikkelen:

• Met de browser developer tools
• Met een debugger in de task pane
• Met de F12 Developer Tools op Windows 10

Omdat HTTPS een vereiste is, worden de React DevTools niet automatisch gestart. Dit moet je handmatig doen, en daarbij een bestaand x.509 keypair opgeven. Bijvoorbeeld:

KEY="/Users/patrick/.office-addin-dev-certs/localhost.key" CERT="/Users/patrick/.office-addin-dev-certs/localhost.crt" node node_modules/.bin/react-devtools

De dev server verzorgt hot module reload, maar wil je handmatig compileren:

npm run build:dev

Tests draaien

Coding style tests

• npm run lint voor alle linters.
• npm run lint:fix voor alle linters en automatisch herstellen (waar mogelijk).
• npm run prettier voor code formatting

Manifestvalidatie

• npm run validate

Deployment

Bouwen voor productie

npm run build

Gebouwd met

• Axios - HTTP client
• Babel - ES6 transpiler
• ESLint - JavaScript linter
• NodeJS - JavaScript runtime
• Office Addin Scripts
• React - JavaScript framework
• React Router - Hash router
• PostCSS - CSS transformaties
• Prettier - Code formatter
• Styled Components
• StyleLint - CSS linter
• Webpack - bundler
• UUID

Bijdragen

Zie CONTRIBUTING.md voor de inhoudelijke procesafspraken.

Versioning

Gebruikt SemVer.

Auteurs

• Patrick Godschalk (Mozard) - Ontwikkelaar - pgodschalk

Zie ook de lijst van contributors die hebben bijgedragen aan dit project.

Licentie

SPDX license: GPL-3.0-or-later

Copyright (c) 2006-2021 Mozard B.V.

Leveringsvoorwaarden