Skip to content

Latest commit

 

History

History
39 lines (29 loc) · 4.95 KB

README.md

File metadata and controls

39 lines (29 loc) · 4.95 KB

Bloomreach Web Code Samples

This repository holds code samples that demonstrate how to implement the various features offered by the Bloomreach product

Examples

Discovery

Search Source Edit on CodeSandbox
Autosuggest Source Edit on CodeSandbox
Recommendations Source Edit on CodeSandbox
Facets Source Edit on CodeSandbox
Categories Source Edit on CodeSandbox
Dynamic grouping Source Edit on CodeSandbox
Relevance by segment Source Edit on CodeSandbox
Visual search Source Edit on CodeSandbox
Multi-language Source Edit on CodeSandbox
Pixel instrumentation Source Edit on CodeSandbox

Guidelines for writing a code sample

  • The code should be optimized to be run in an online code editor, launched with one click from the repository and be able to interactively edit code and run it
  • The code should be generic, so you can plug in configuration of any account and they should work.
  • The code sample should run with a sample input on load and should not require any user interaction or setup to run it. For example, if it’s a search input, add a default query text in the input, if it is visual search, setup a sample image on load and have some sample images in the sample code directory. This might not be possible in all cases, but try to minimize user setup to run the code sample
  • The code sample should be concise. Balance code readability with robustness. The intention of the code samples is to educate about product features, demonstrate it's usage, enable rapid prototyping and not to write production grade code.
  • Do not make a code sample that is too complex or has too many dependencies. Keep in mind long term maintenance of a code sample, as the underlying APIs and the libraries are updated over time.
  • If a code sample stops working, it should be removed.

Related resources

Contributing

Contributions are welcome. Please read the guidelines above and open a pull request and one of our team members will help get it reviewed and merged