https://github.com/empathyco/x-archetype
Search experience layout built with Interface X Components
https://github.com/empathyco/x-archetype
agnostic-to-frameworks components components-library discovery e-commerce elasticsearch event-driven front-end frontend javascript open-source privacy search web
Last synced: over 1 year ago
JSON representation
Search experience layout built with Interface X Components
- Host: GitHub
- URL: https://github.com/empathyco/x-archetype
- Owner: empathyco
- License: apache-2.0
- Created: 2021-06-07T08:48:25.000Z (about 5 years ago)
- Default Branch: main
- Last Pushed: 2025-03-17T04:44:50.000Z (over 1 year ago)
- Last Synced: 2025-03-17T05:30:48.772Z (over 1 year ago)
- Topics: agnostic-to-frameworks, components, components-library, discovery, e-commerce, elasticsearch, event-driven, front-end, frontend, javascript, open-source, privacy, search, web
- Language: Vue
- Homepage:
- Size: 11.4 MB
- Stars: 16
- Watchers: 21
- Forks: 6
- Open Issues: 8
-
Metadata Files:
- Readme: README.md
- License: LICENSE
- Code of conduct: .github/CODE_OF_CONDUCT.md
- Codeowners: .github/CODEOWNERS
- Security: SECURITY.md
Awesome Lists containing this project
README
# Interface X
[](https://opensource.org/licenses/Apache-2.0)
[](https://www.empathy.co)
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](./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:
- If you want to export to a .csv file the messages of the project:
```shell
npm run json:csv
```
- If you want to import the translations in a .csv file to this project:
```shell
npm run csv:json
```
In that case you need to put the .csv files inside a folder called `output`in the root directory.
## License
[Apache 2.0](./LICENSE)