React Boilerplate for Custom Demos

Welcome to the parent directory of the Boilerplate. You can find detailed documentation on how to build your own Algolia demo here

🧱 Structure

This parent directory contains on sub-directory apps that contains two sub-directories:

1/ boilerplate-documentation: This folder contain everything you need to know about the boilerplate application from setting up and getting started to details about every component we're using in this application

2/ boilerplate-front-end This folder contains the front-end code itself. If you wish to use the boilerplate as a template this is the folder you want to modify. You can find every details about how to modify this template the way you want in the boilerplate documentation here. You can also find all the details in the readMe here. Without any modification from you, you'll be able to find the front-end here.

🚀 Quick get started

If you'd like to start using this boilerplate for a project, please template this repository to get started. You can either clone this repository or fork it. If you're choosing to fork it please mind your future pushes and PR's

This repository is using Workspaces/Monorepo with TurboRepo.

Pre-requisites

Before proceeding, please make sure you have the following:

• Node v16.14+ installed
• pnpm installed here.

How to run the apps

To init and install dependancies please use :

pnpm install

To start both applications (documentation - localhost:3001 & front-end - localhost:3000) please use:

pnpm start

To start only the front-end please use:

pnpm start:front

To start only the documentation please use:

pnpm start:docs

To build both applications please use:

pnpm build

If you get an error during the installation about the package turbo-darwin-64, please install the package separately :

pnpm install turbo-darwin-64

👌 What is the Boilerplate?

The Boilerplate is a tool built by the Demo Engineering team of Algolia to help build neat, reliable and fast custom demos that showcase most of the features of Algolia.

The Boilerplate is highly scalable, and customizable. It is made with ReactInstantSearchHooks and it is ready to be configured and deployed quickly.

By following the steps described in this documentation you will be able to build your own Algolia application in matter of minutes.

Happy Coding!

boilerplate-demo-with-neural