Skip to content

Commit

Permalink
docs: add installation instructions (#110)
Browse files Browse the repository at this point in the history
  • Loading branch information
herrardo authored Jun 21, 2022
1 parent cd2ff72 commit 682aef3
Showing 1 changed file with 10 additions and 0 deletions.
10 changes: 10 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -13,6 +13,16 @@ the [documentation](./docs/index.md).
If you want to contribute to this project please keep in mind that it uses
[Conventional Commits](https://www.conventionalcommits.org/) for its commit messages.

## How to install

This project is a default setup of the [Interface X Components](https://github.com/empathyco/x). 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:
Expand Down

0 comments on commit 682aef3

Please sign in to comment.