diff --git a/.github/CONTRIBUTING.md b/.github/CONTRIBUTING.md index 7fe53795b0..4aa8ee473d 100644 --- a/.github/CONTRIBUTING.md +++ b/.github/CONTRIBUTING.md @@ -66,7 +66,10 @@ evolves. such as [prettier](https://prettier.io/). - **[@empathyco/x-jest-utils](/packages/jest-utils)** - Jest extensions for easier testing. - **[@empathyco/x-logger](/packages/logger)** - A custom implementation of a logger. -- **[@empathyco/x-adapter](/packages/search-adapter)** - A search client for Empathy's Search API. +- **[@empathyco/x-adapter](/packages/x-adapter)** - A set of tools to manage trough schemas API + calls and transform the responses to map it to x-types +- **[@empathyco/x-adapter-platform](/packages/x-adapter-platform)** - A x-adapter implementation to + manage requests and responses to Empathy Platform APIs - **[@empathyco/x-types](/packages/x-types)** - TypeScript types & guards for X models. - **[@empathyco/x-storage-service](/packages/storage-service)** - Storage service with TTL. - **[@empathyco/x-react-wrapper](/packages/react-wrapper)** - A proxy that transforms Vue components @@ -74,6 +77,12 @@ evolves. - **[@empathyco/x-translations](/packages/x-translations)** - A project that allows you to import and export the translations. - **[@empathyco/x-utils](/packages/x-utils)** - provides utilities to ease the development. +- **[@empathyco/x-archetype-utils](/packages/x-archetype-utils)** - provides utilities to ease the + development. It's used in the Interface X Archetype project. +- **[@empathyco/x-bus](/packages/x-bus)** - provides an event bus to help with event orchestration. +- **[@empathyco/x-tailwind](/packages/x-tailwind)** - Empathy X Tailwind plugin that represent a + design system builder. With this package you are able to create a design system through a + cofiguration file ## How to contribute @@ -117,7 +126,8 @@ development environment, proceed as follows: 1. Fork the X repo and then clone it to your local environment: `git clone https://github.com/empathyco/x.git`. -2. Install the dependencies in the root folder: `npm install`. This links all the projects. +2. Install the dependencies in the root folder: `pnpm install --frozen-lockfile`. This links all the + projects. 3. Run a build so that the linked projects work: `npm run build`. ### Pull requests diff --git a/README.md b/README.md index 688a5aa95c..f7f19392c0 100644 --- a/README.md +++ b/README.md @@ -129,12 +129,10 @@ We are working on many key features to consolidate Interface X, including these - **Filtering Strategies**: Added filtering capabilities to History Queries and Brand Recommendations [![Release Docs](https://img.shields.io/badge/Released-October%202023-brightgreen)](https://docs.empathy.co/explore-empathy-platform/experience-search-and-discovery/history-queries.html) -- **Suggestions with filters** that allows to select a query suggestion with a specific filter. - ![Release Docs](https://img.shields.io/badge/Discovery-Q3%202023-blue) -- **Result Preview component** to rapidly discover more result attributed without leaving the SERP. - ![Release Docs](https://img.shields.io/badge/Discovery-Q4%202023-blue) +- **Experience Controls**: Add capability of loading configurations from an external service + [![Release Docs](https://img.shields.io/badge/In%20Progress-yellow)](https://vuejs.org/) - **Vue 3 Migration**. - [![Release Docs](https://img.shields.io/badge/Discovery-Q4%202023-blue)](https://vuejs.org/) + [![Release Docs](https://img.shields.io/badge/In%20Progress-yellow)](https://vuejs.org/) - **Network Request failure transparency**. - **Project generator CLI**. - **Observability**: Error capturing & monitoring.