Skip to content

acquia-pso/chn1-search

Repository files navigation

CHN-Yext

Preview in Gitpod

https://gitpod.io/#https://github.com/phase2/chn-yext

Overview

This package contains the necessary files and configurations to set up and run the CHN-Yext project.

Installation and Setup

Follow these steps to get the project up and running on your local machine:

Prerequisites

  • Ensure you have Node.js installed on your system.
  • Yarn package manager is required. If you do not have Yarn installed, you can install it by running:
    npm install -g yarn
  • You need access to the repo chn-yext

Installation

  1. Clone the repository to your local machine.
  2. Navigate to the project directory.
  3. Install the dependencies:
    yarn install

Building the Project

To build the project, run the following command:

yarn build

This command compiles the source code and generates output files in the dist directory.

Viewing the Application

After building the project, open the build.html file in your web browser to view the application.

Support

For any issues or questions, please open an issue on the GitHub repository issue tracker.

Workflow

There are different kinds of work flow for yext project details can be found on the Yext Workflow Options

We can mark tickets in the name for the workflow need

Items that need code changes will be QA in Gitpod

When ready to deploy to aquia the developer will make a PR to the main branch of the aquia repo https://github.com/acquia-pso/chn1-search

Generating Testing workspace in Gitpod

For code changes testers should use gitpod to create a env from the main branch when they are ready to test. They do this by:

  • go to the CHN new workspace page
  • Click Continue
  • A code editor page will popup and then a min or so later a test page will popup
  • Test on the second page. You can keep this page around until you are told there was a new code push, then you must stop using this site and run this process again

Dashboard

If you want to go back to one of your other workspaces you can see them all in the Dashboard.

Note that if you do not use a workspace it will shutdown, and if you do not touch it for 2 weeks it will be automatically deleted

Share workspace.

If as a testing you need to share the env with a developer to show them things are not working then:

  • go to the code page
  • click on the hamburger menu
  • click on GitPod:Share Running Workspace
  • click share in the popup
  • look to the bottom right of the page and click Copy URL to Clipboard
  • send the url to the developer