Skip to content

Commit

Permalink
- update README.md
Browse files Browse the repository at this point in the history
  • Loading branch information
viktor-silakov committed Mar 14, 2023
1 parent 12148ce commit b6d9e4f
Showing 1 changed file with 23 additions and 19 deletions.
42 changes: 23 additions & 19 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,37 +5,46 @@ provides API for Test Automated solutions and a convenient UI tool to review and

## Prerequisites

* [NodeJS](https://nodejs.org/en/download/) `v14.16` or above, it is preferably to
There are two modes in which we could run Syngrisi:
- Native mode: When you run this with nodejs on your OS, it's usually fine to run the application on the local system.
- Container mode: using docker and docker-compose, this is more suitable for production use.

### Native Mode
* [NodeJS](https://nodejs.org/en/download/) `v14.20` or above, it is preferably to
use [nvm](https://github.com/nvm-sh/nvm);
* [MongoDB Community Edition](https://docs.mongodb.com/manual/administration/install-community/)

## Quick start

> ⚠️ Make sure MongoDB started before run Syngrisi
### Container Mode
* [Docker + Docker Compose](https://docs.docker.com/engine/install/)

Clone this project:
## Quick start

```shell script
git clone git@github.com:viktor-silakov/syngrisi.git
### Native Mode
Install in current folder
```bash
npm init sy@latest
```
Install in certain folder
```bash
npm init sy@latest <path_to_syngrisi>
```
> ⚠️ Make sure MongoDB started before run Syngrisi
Go to application folder and install Dependencies
Run the server

```shell script
npm install
npm start
```

Run Syngrisi server
### Container Mode

```shell script
npm start
sudo docker-compose up
```

## Example Project Based on Syngrisi

You can set up the [example TA Solution](https://github.com/viktor-silakov/syngrisi-cucumber-example) based
on [WebdriverIO Cucumber Boilerplate](https://github.com/webdriverio/cucumber-boilerplate) project, it also can be good
point to start new TA project from scratch.
You can set up the [Syngrisi Cucumber Boilerplate project](https://github.com/viktor-silakov/syngrisi-cucumber-boilerplate) with pre-defined Functional and Visual Syngrisi checks steps.

## Features

Expand All @@ -50,11 +59,6 @@ point to start new TA project from scratch.
* Affected elements analyse based on DOM dump and diff image.
* UI panel to observe results and manage test data (baselines, regions, test, suites, runs. etc.) )

## Clear database and screenshots files

```shell script
npm run clear
```

## Environment variables

Expand Down

0 comments on commit b6d9e4f

Please sign in to comment.