CONTRIBUTING.MD

Preparing Majestic

• Clone this repository
• Install dependencies with yarn install

Running Majestic

Majestic has 2 main components as follows

• The UI written in React JS and GraphQL
  • The UI source is in ./ui - Running yarn ui will start the webpack dev server
• A Node JS GraphQL server
  • The server source is in ./server
  • Create a sample projector use one of your project with Jest so you can test your changes
  • If you are using VSCode, edit the \.vscode\launch.json file and change the ROOT directory to your sample project and then you can press F5 to run the server.
  • If you are not using VSCode, edit the \server\services\cli.ts file and change the root path so you test with your sample project and then running yarn watch-server will start the server in watch mode

Running integration test

We have a couple of integration tests written using Cypress available in the ./integration folder.

To run the integration test

• Do a production build by running yarn prod
• cd ./integration
• Run yarn prepare-packages to install required packages
• Run yarn run-integration to run the integration tests

Building Production Bundle

The UI is built by Webpack and the server is also built by Webpack to decrease install times.

Run yarn prod to build a production bundle and the artifacts would be available in dist folder.

Publishing a new release

Running yarn ship will perform a production build and will publish a new version to npm.