Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/itemconsulting/xp-part-finder
Developer utilities for working with xp components
https://github.com/itemconsulting/xp-part-finder
Last synced: about 2 months ago
JSON representation
Developer utilities for working with xp components
- Host: GitHub
- URL: https://github.com/itemconsulting/xp-part-finder
- Owner: ItemConsulting
- License: mit
- Created: 2024-04-04T11:16:23.000Z (9 months ago)
- Default Branch: main
- Last Pushed: 2024-08-28T10:44:02.000Z (5 months ago)
- Last Synced: 2024-08-28T12:46:24.072Z (5 months ago)
- Language: TypeScript
- Size: 395 KB
- Stars: 0
- Watchers: 0
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# Part Finder
When you are working on an XP-part you want to know where on your site it's being used, so that you can test it or
update the configuration.
This application gives insight into which content uses which of your components.
[](https://jitpack.io/#no.item/xp-part-finder)
## Setup
Install npm-dependencies
```bash
npm install
```
To prepare the Storybook-environment you need to create a _.env_ file. The easiest way is to copy over the existing
_.env_example_ file.
```bash
cp .env_example .env
```
> [!IMPORTANT]
> Make sure `STORYBOOK_SERVER_URL` in _.env_ matches a valid service path in **your** local XP setup.
## Running storybook
To make development easier and quicker, pages, layouts, parts and Freemarker-macros have Storybook-stories that let us
get immediate feedback when developing.
To be able to run Storybook locally you need to install [xp-storybook](https://github.com/ItemConsulting/xp-storybook)
in your local sandbox. When it is installed, you can run storybook locally with the following command:
```bash
npm run storybook
```
## Building
To build the project, run the following command
```bash
enonic project build
```
You will find the jar-file at _./build/libs/item.jar_
## Deploying locally
To deploy to a local sandbox, run the following command
```bash
enonic project deploy
```
## Deploy to Jitpack
Go to the [Jitpack page for xp-part-finder](https://jitpack.io/#no.item/xp-part-finder) to deploy from Github.