Skip to content

README.md

Latest commit

 

History

History
55 lines (39 loc) · 1.6 KB

README.md

File metadata and controls

55 lines (39 loc) · 1.6 KB

Development

New here? See CONTRIBUTING.md for the contribution workflow, branch naming, commit message conventions, and PR guidelines before diving in.

The project relies on Node Js.

We use vue.js as a frontend framework and PrimeVue for the UI components.

Installation

To launch the application, follow these steps:

  1. Clone the repository to your local machine: 
    git clone https://github.com/MetaConfigurator/meta-configurator.git
  2. Navigate into web application folder: 
    cd meta-configurator/meta_configurator
  3. Install the necessary dependencies: 
    npm install
  4. Launch the application: 
    npm run dev

Formatting and Linting

When you push your changes to the repository, one of the Github workflows automatically performs a linting check, as well as an automated formatting. To run the linting or formatting by yourself, type:

npm run lint
npm run prettier

To avoid/fix merge conflicts due to the automated formatting, you can do either:

  1. Call npm run prettier locally before you push.
  2. Or before you push a second time, first pull the new formatting changes.
  3. Or rebase and simply overwrite all formatting changes of the remote with your current code. The formatting will anyways be executed again.

Tests

For detailed testing descriptions, see the testing documentation

In short, run unit tests and end-to-end tests the following way:

npm run test
npm run test:e2e