Skip to content

Commit

Permalink
update readme
Browse files Browse the repository at this point in the history
  • Loading branch information
paradajz committed Oct 1, 2023
1 parent 7c8b8f7 commit f5ef05b
Showing 1 changed file with 12 additions and 5 deletions.
17 changes: 12 additions & 5 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -14,9 +14,16 @@ The configurator is always available online via [this link](https://config.shant

## Development

This project uses Vue, Vite, Tailwind and Typescript. For development usage, make sure `yarn` command is installed. After that, development version of the configurator with local server can be started with the following commands:
This projects uses Docker container for development. To use it, run the following command from the root repository directory:

```
yarn
yarn dev
```
./scripts/dev.sh

The development version of the configurator with local server can be started with the following commands:

make

To package the configurator for offline usage, `make pkg` command can be used with `PLATFORM` variable being set to the platform for which to build the configurator:

* Linux: `make pkg PLATFORM=linux`
* Windows: `make PLATFORM=win32`
* macOS: `make PLATFORM=darwin`

0 comments on commit f5ef05b

Please sign in to comment.