PowerHouse

Linking Dependencies Between Projects and Packages <a id="linking-deps"></a>

To link a dependency into a project, add it to your package.json and point the dependency version to workspace:*

package.json

{
  "name": "my-new-package",
  "version": "0.0.0",
  "scripts": {
    ...
  },
  "dependencies": {
    ...
    "@pgph/pkg-a": "workspace:*", // Link to a local dependency
    "@pgph/pkg-b": "workspace:*",
    "@pgph/pkg-c": "workspace:*"
  }
}

Next, add a path reference to the tsconfig.json file.

````json { "references": [ { "path": "../../packages/<package_name>" } ] }

Prerequisites

• Docker Engine (version 20.10.0 or later)
• Docker Compose (version 2.0.0 or later)

Using Docker

This project can be run using Docker and Docker Compose. The docker-compose.yml file in the root directory defines the services and their configurations.

Rebuild a specific service

docker compose up -d --build switchboard # Rebuild and start Switchboard docker compose up -d --build connect # Rebuild and start Connect ```

Basic Usage

1. Build and start all services:

   docker compose up
   

1. Run in detached mode (background):

   docker compose up -d
   

1. View running containers:

   docker compose ps
   

1. View logs:

   docker compose logs -f
   

5. Stop all services:

   docker compose down
   

Adding a New Package or App <a id="add-new-package"></a>

Packages:

Currently, only the main branch is enabled in this project, which means all packages are deployed to NPM from the main branch. To contribute to a package, please follow these steps:

1. Create a feature branch from the main branch:

   git pull origin main
   git checkout main
   git checkout -b feature/my-branch
   

2. Make your changes in the feature branch. 3. Once your changes are ready, commit them following the conventional commits standard: - Try to keep your commits scoped (do not include files from multiple packages in a single commit). - Include the package scope affected by your changes in the commit message, for example:

     git commit -m "feat(document-model): my commit message"