x archetype

Interface X

Welcome to the Interface X Archetype

What is this repository for?

The purpose of this repository is to be the starting point to a customer setup using the X Components. Please take a look at the documentation.

If you want to contribute to this project please keep in mind that it uses Conventional Commits for its commit messages.

How to install

This project is a default setup of the Interface X Components. To run the project and see the components up&running:

1. Clone it to your local environment: git clone https://github.com/empathyco/x-archetype.git.
2. Install the dependencies npm install
3. Run the development server: npm run serve.
4. Open http://localhost:8080.

Translations

This project has a couple a of npm commands which allow you to export/import the translations:

• If you want to export to a .csv file the messages of the project:

npm run json:csv

• If you want to import the translations in a .csv file to this project:

npm run csv:json

In that case you need to put the .csv files inside a folder called outputin the root directory.

License

Apache 2.0