salix/README.md

1.8 KiB

Salix

This project is an Enterprise resource planning (ERP) integrated management of core business processes, in real-time and mediated by software and technology developed with the stack listed below.

Salix is also the scientific name of a beautifull tree! :)

Prerequisites

Required applications.

  • Docker
  • Git

Optional.

  • NodeJS

Directory structure recommendation

  • /Salix
    • /back ← this project
    • /front ← salix-front project

Installing dependencies and launching

Pull from repository.

$ git clone [url] [directory]

Run this commands on project root directory to install Node dependencies.

$ sh init.sh

Launch application in developer environment.

$ docker compose -f docker-compose.local.yml up

# Or with NodeJS
$ npm run start

Manually reset fixtures if has changes.

$ sh db/reset.sh

Manually reset strucutre/fixtures always.

$ sh db/reset.sh --no-cache

Running the unit tests

For client-side unit tests run from project's root.

$ sh runTest.sh front

# Or with NodeJS
$ npm run test:front

For server-side unit tests run from project's root.

$ sh runTest.sh back

# Or with NodeJS
$ npm run test:back

For end-to-end tests run from project's root.

$ npm run test:e2e

Visual Studio Code extensions

Open Visual Studio Code, press Ctrl+P and paste the following commands.

In Visual Studio Code we use the ESLint extension.

ext install dbaeumer.vscode-eslint

Built With