Skip to content

Latest commit

 

History

History
49 lines (30 loc) · 2.14 KB

CONTRIBUTING.md

File metadata and controls

49 lines (30 loc) · 2.14 KB
Raw

Contributing to Mockoon

There are many ways to contribute to Mockoon: opening bugs or issues, submitting pull requests, suggesting new features...

After cloning the repository please check the opened and unassigned issues. If you want to contribute significant changes please discuss with the maintainers before starting to work. Please note that Mockoon promise is to be simple, easy to use, and fast. So not all features are worth implementing and maintainer may chose to not implement features that are out of Mockoon's scope.

Build and run

Prerequisites:

  • Node.js >= 8.x.x

Clone the repository: [email protected]:mockoon/mockoon.git

Run the application in dev mode

  • Run npm install.
  • Run npm run serve:app and npm run serve:electron.

You will get hot reload on both Angular and Electron applications.

Run the tests

Tests are written with Spectron and you can run them using npm run test-spectron. These tests will also be run on each commit or pull request by CircleCI.

When running the tests locally, you will first need to run npm run build:dev in order to have an application build to test against.

Build and package the application for production

  • Increment the version in package.json files. Use npm run setversion x.x.x.
  • Run npm run build:prod.
  • Package the application for different platforms with npm run package:win|mac|linux.
  • Create a release in GitHub 'mockoon' repository. (Respect release tag format vx.x.x)
  • Add binaries to the new GitHub release.

You will get a packaged application in ./packages folder. Mac version can only be built and signed on Mac OS.

Note that Windows and Mac OS versions need to be signed when packaged. This is the responsibility of maintainers (see below).

/!\ Auto update depends on GitHub release proper taging (vx.x.x) and binaries correct naming (as set in package.json and update.service.ts). Do not change them.

Distribute the application

Only maintainers are entitled to build and package the application with Windows code signing and Mac OS certificates.

Do not forget to update Homebrew cask repository. Chocolatey package should be automatically updated.