Skip to content

Getting Started

Installation

Can be installed from using NPM or Yarn.

bash
npm install --save-dev phrasey
yarn add --dev phrasey
npm install --save-dev phrasey
yarn add --dev phrasey

Additionally, install the required formats for your project. Common formats including JSON, YAML, TOML, XML can be installed using below commands.

bash
npm install --save-dev @zyrouge/phrasey-json
npm install --save-dev @zyrouge/phrasey-yaml
npm install --save-dev @zyrouge/phrasey-toml
npm install --save-dev @zyrouge/phrasey-xml
# or preferably using yarn
npm install --save-dev @zyrouge/phrasey-json
npm install --save-dev @zyrouge/phrasey-yaml
npm install --save-dev @zyrouge/phrasey-toml
npm install --save-dev @zyrouge/phrasey-xml
# or preferably using yarn

Also, read about translation string formats.

Setting up a project

Use the init command to create and initialize a new project.

bash
npx phrasey init
npx phrasey init

This prompts a set of question which are used to create the configuration and schema file.

Made with ❤️ by Zyrouge.