Quick Start
Welcome to the Concordia 2 documentation! This page will help you to get started fast. If you run into problems, you can find help on our Slack channel.
Concordia Compiler requires only NodeJS version 12.20 (or above) and works on Linux, MacOS and Windows.
In this Quick Start, we'll create a simple specification of an interaction with a search page and use Google Chrome. Therefore, download it before continuing.
If you are starting a new project or whether your project does not have a file named
package.json
, then run:npm init --yes
You can use NPM, Yarn or PNPM.
npm i -D concordialang
It will install version 2 that is in alpha stage, although stable.
Note that the needed package name is
concordialang
(with lang
). After installing it, we'll always use npx concordia
to execute it.npx concordia --init
Concordia Compiler will ask you about some preferences. Press
Enter
to answer every question with their default values. It will create a configuration file named .concordiarc
and install the selected plug-in and database drivers.Create the folder
features
:mkdir features
Now create the file
search.feature
withinfeatures
, with the following content:search.feature
Feature: Search
Scenario: Shows results that correspond to the term
Variant: Search by pressing Enter
Given that I am on "https://google.com"
When I type "concordialang" in <q>
And I press "Enter"
And I wait for 2 seconds
Then I see "npm"
About the file:
- Feature and Scenario are high-level, business-focused descriptions about the problem to solve. Their sentences are not used to generate test cases. The above example does not describe them.
- A Variant describes the expected interaction with the application's user interface (UI) in order to perform a Scenario. Thus, a Variant uses technological vocabulary.
- In Concordia, all the interactions with the UI use first person singular ("I"). That "I" represents the actor that is interacting with the application (in the example above, a visitor).
Finally, run
npx concordia