@syngrisi/syngrisi 2.2.3 → 2.2.6-alpha.0

package/README.md

@@ -65,7 +65,7 @@ file. To download and execute Docker and Docker Compose files for Syngrisi, foll
 
 ```bash
 # Check if docker-compose is installed
-command -v docker-compose >/dev/null 2>&1 || { echo >&2 "docker-compose is required; please install it and run this command again."; exit 1; }
+command -v docker compose >/dev/null 2>&1 || { echo >&2 "docker-compose is required; please install it and run this command again."; exit 1; }
 
 # Create the project folder
 mkdir my_new_syngrisi_project && cd my_new_syngrisi_project
@@ -75,7 +75,7 @@ curl -LO https://raw.githubusercontent.com/syngrisi/syngrisi/main/packages/syngr
 curl -LO https://raw.githubusercontent.com/syngrisi/syngrisi/main/packages/syngrisi/docker-compose.yml
 
 # Create and start services
-sudo docker-compose up
+sudo docker compose up
 ```
 
 You are free to modify the Docker Compose file according to your requirements. Ensure that service definitions and options are set up correctly; otherwise, services may not function as expected.
@@ -84,7 +84,7 @@ Environment variables for Docker Compose can be configured either in an environm
 configuration instructions, please refer to the Syngrisi documentation.
 
 ```shell script
-sudo docker-compose up
+sudo docker compose up
 ```
 
 ## Syngrisi Boilerplates  <a name="boilerplates"></a>
@@ -106,28 +106,15 @@ macOS/Linux: `export SYNGRISI_LOG_LEVEL=debug`
 You can also include the variables in your `.env` or modify variables in `docker-compose.yml` file before start Syngrisi
 service.
 
-| Variable                       | Host | Docker | Description                                                                                                                                                       | Default Value                          |
-|--------------------------------|------|--------|-------------------------------------------------------------------------------------------------------------------------------------------------------------------|----------------------------------------|
-| `SYNGRISI_DOCKER_IMAGES_PATH`  | -    | +      | Path to the internal Docker folder for Syngrisi images, including screenshots and diffs.                                                                          | `./.snapshots-images`                  |
-| `SYNGRISI_DOCKER_PORT`         | -    | +      | Docker external Syngrisi App Server Port (host port)                                                                                                              | `5000`                                 |
-| `SYNGRISI_DOCKER_DB_PORT`      | -    | +      | Docker external Syngrisi Database Server Port (host port)                                                                                                         | `27017`                                |
-| `SYNGRISI_DOCKER_DB_AUTH_ARG`  | -    | +      | To enable mongo database authentication set it to `--auth` be sure that you create user for `SyngrisiDb` database and add appropriate values to connection string | `--noauth`                             |
-| `SYNGRISI_DOCKER_BACKUPS_PATH` | -    | +      | Host Backup Folder path                                                                                                                                           | ./backups/                             |
-| `SYNGRISI_DOCKER_DB_PATH`      | -    | +      | Host Path to Syngrisi Database files                                                                                                                              | `./data/db_data`                       |
-| `SYNGRISI_DB_URI`              | +    | +      | [Connection URI](https://www.mongodb.com/docs/manual/reference/connection-string/) for Mongo DB service                                                           | `mongodb://127.0.0.1:27017/SyngrisiDb` |
-| `SYNGRISI_IMAGES_PATH`         | +    | +      | Path to the folder for Syngrisi images, including screenshots and diffs.                                                                                          | `./.snapshots-images/`                 |
-| `SYNGRISI_APP_PORT`            | +    | -      | TCP port for application server                                                                                                                                   | `3000`                                 |
-| `SYNGRISI_AUTH`                | +    | +      | Enables authentication                                                                                                                                            | `1`                                    |
-| `MONGODB_ROOT_USERNAME`        | -    | +      | Username for the Database Root user, that will be created at first Applications start                                                                             | -                                      |
-| `MONGODB_ROOT_PASSWORD`        | -    | +      | Password for the Database Root user, that will be created at first Applications start                                                                             | -                                      |
-| `LOGLEVEL`                     | +    | -      | Log level (`error` `warn`,`info`,`verbose`,`debug`,`silly`)                                                                                                       | `debug`                                |
-| `SYNGRISI_PAGINATION_SIZE`     | +    | -      | Number of tests items on that return `/checks?page={page_num}` API                                                                                                | `50`                                   |
-| `SYNGRISI_TEST_MODE`           | +    | +      | Enables test admin user if equal `1`, used only for tests purposes                                                                                                | `0`                                    |
-| `SYNGRISI_DISABLE_FIRST_RUN`   | +    | +      | Disable first run procedure, disabled if equal `1`, used only for tests purposes                                                                                  | `0`                                    |
-| `SYNGRISI_DISABLE_DEV_CORS`    | +    | -      | Disable CORS for vite dev server, only for dev and test purposes                                                                                                  | `-`                                    |
-| `SYNGRISI_SESSION_STORE_KEY`   | +    | +      | A Secret for session storage                                                                                                                                      | random generated                       |
-| `SYNGRISI_COVERAGE`            | +    | -      | Enable coverage, if `true` generated coverage data to `./coverage`                                                                                                | -                                      |
-| `SYNGRISI_HTTP_LOG`            | +    | +      | Enable HTTP logs, if `true` logging all HTTP request to `./logs/http.log` file                                                                                    | `false`                                |
+More details on environment variables are available in the [docs/environment_variables.md](docs/environment_variables.md) file.
+
+## API documentation
+
+To view the OpenAPI documentation, use Swagger. The documentation is available at:
+
+Swagger UI: `http://your-domain/swagger/`
+
+Swagger JSON: `http://your-domain/swagger/json`
 
 ## Devices list <a name="devices"></a>
 
@@ -135,7 +122,40 @@ Syngrisi includes a [list](./static/data/custom_devices.json) of recognized devi
 
 The application sets the platform icon based on this list. Do not edit this file directly. If you wish to add your own devices, simply create an additional file named `custom_devices.json`; the data from this file will be appended to the main list.
 
+## Development
+
+> [!NOTE]  
+> Before setting up your project, make sure MongoDB is installed.
+
+- Clone the repository and go to the Syngrisi package folder.
+
+    ```sh
+    git clone git@github.com:syngrisi/syngrisi.git
+    cd syngrisi/packages/syngrisi/
+    ```
+- Install dependensies 
+    ```sh
+    npm run install:all
+    ```
+- Build the project
+
+    ```sh
+    npm run build
+    ```
+- Copy `.env.template` to `.env` and set your own variables if needed
+
+    ```sh
+    cp .env.template .env
+    ```
+
+- Start the application 
+
+    ```sh
+    npm start
+    ```
+
 ## License
 
 Syngrisi is available under the MIT License. For more details, refer to the [LICENSE](./LICENSE.md) file.
 
+