Skip to content

Latest commit

 

History

History
75 lines (50 loc) · 3.06 KB

development.md

File metadata and controls

75 lines (50 loc) · 3.06 KB
Raw

Development

Before your commit, a good practice is to:

  1. Run unit tests
  2. Lint your code

You could run other types of tests as well, but they may take longer time and overkill for your changes. Automated actions executes the tests for a pull request or change in the main branch. See ci-cd.md for more information.

Commands

Prerequisites

  • Install node >15.x.
  • Install dependencies using npm install.

Testing

  • Run unit tests: npm run test:unit
  • Run integration tests: npm run test:integration
  • Run end-to-end (e2e) tests:
    • npm run test:cy:open: Run tests interactively using the development server with hot-reloading.
    • npm run test:cy:run: Run tests on the production build in a headless mode.

📖 Read more about testing in tests.

Linting

  • Lint all (recommended 💡): npm run lint
  • Markdown: npm run lint:md
  • Markdown consistency npm run lint:md:consistency
  • Markdown relative URLs: npm run lint:md:relative-urls
  • JavaScript/TypeScript: npm run lint:eslint
  • Yaml: npm run lint:yaml

Running

Web:

  • Run in local server: npm run dev
    • 💡 Meant for local development with features such as hot-reloading.
  • Preview production build: npm run preview
    • Start a local web server that serves the built solution from ./dist.
    • 💡 Run npm run build before npm run preview.

Desktop apps:

  • npm run electron:dev: The command will build the main process and preload scripts source code, and start a dev server for the renderer, and start the Electron app.
  • npm run electron:preview: The command will build the main process, preload scripts and renderer source code, and start the Electron app to preview.
  • npm run electron:prebuild: The command will build the main process, preload scripts and renderer source code. Usually before packaging the Electron application, you need to execute this command.
  • npm run electron:build: Prebuilds the Electron application, packages and publishes it through electron-builder.

Docker:

  1. Build: docker build -t undergroundwires/privacy.sexy:latest .
  2. Run: docker run -it -p 8080:80 --rm --name privacy.sexy undergroundwires/privacy.sexy:latest

Building

  • Build web application: npm run build
  • Build desktop application: npm run electron:build
  • (Re)create icons (see documentation): npm run create-icons

Utility Scripts

  • Run fresh NPM install: ./scripts/fresh-npm-install.sh
    • This script provides a clean NPM install, removing existing node modules and optionally the package-lock.json (when run with -n), then installs dependencies and runs unit tests.
  • Configure VSCode: ./scripts/configure-vscode.sh
    • This script checks and sets the necessary configurations for VSCode in settings.json file.

Recommended extensions

You should use EditorConfig to follow project style.

For Visual Studio Code, .vscode/extensions.json includes list of recommended extensions.