search

mkclawson / impala

Apache License 2.0
2 stars 3 forks source link

Update readme #1

Open helms-charity opened 1 year ago

helms-charity commented 1 year ago

Can use https://github.com/hlxsites/maidenform as a guide. The "choosing the environment" part there is special to Maidenform, so can omit that.

Toto-Tuo commented 1 year ago

@helms-charity The referenced URL https://github.com/hlxsites/maidenform is returning 404. Do you have an updated URL for the content you referenced? Thanks

helms-charity commented 1 year ago

oh I guess it is private. Here, I will paste what that readme looks like.

Add to Sidekick

Franklin Maidenform

Your project's description...

Environments

Installation

npm i
# or
yarn

Start

npm run start
# or
yarn start

Local development

  1. Create a new repository based on the helix-project-boilerplate template and add a mountpoint in the fstab.yaml
  2. Add the helix-bot to the repository
  3. Install the Helix CLI: npm install -g @adobe/helix-cli
  4. Start Helix Pages Proxy: hlx up (opens your browser at http://localhost:3000)
  5. Open the {repo} directory in your favorite IDE and start coding :)

Choosing the enviroment

When not running the production website (anything containing maidenform.com) you have the ability to change the default enviroment through two different means.

Currently three enviroment exits:

You can change the environment for a single page by appending the following query parameter config with the environment name. For the homepage in local devolopment, this would result in https://localhost:3000/?config=stage for staging.

You can also modify the enviroment through the session storage this will make sure you can trough a full checkout process on the same enviroment. You would do that by adding an environment variable with the name of the desired environment. You can still override this setting by modifying the query parameters config.

Sitemap

The sitemap.xml is generated by gathering the content of two indexes though the helix-sitemap.yaml:

The static index is directly managed by Franklin upon publication and unpublication of pages.

The Products index is managed through a GitHub action, that will trigger the reindexing of the product pages it will gather the products from querying Commerce GraphQL. The product index is run daily or through a manual execution.

To be able to remove products pages from the sitemap:

  1. The /products/query-index.xlsx should be emptied
  2. The sync-commerce GitHub Action should be executed, this will ensure that only product currently available will be added