From 682aef3af4ee02fc80ff8fa13127d362005be27c Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Gerardo=20V=C3=A1zquez?= Date: Tue, 21 Jun 2022 12:12:45 +0200 Subject: [PATCH] docs: add installation instructions (#110) --- README.md | 10 ++++++++++ 1 file changed, 10 insertions(+) diff --git a/README.md b/README.md index b694399f..64a82161 100644 --- a/README.md +++ b/README.md @@ -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: