A starter powered by Faststore and Gatsby

Kickoff your store with this boilerplate. This starter ships with the main Faststore configuration files you might need to get up and running blazing fast with the blazing-fast store for React.

⚠️ Before you start

As of Dec, 22, 2021, this starter is still far from covering most basic cases found on VTEX. To summarise what we still do not support that is considered basic on the VTEX commerce platform, we prepared the list below. If the feature you want is listed, you can either wait for us to add support to the feature, or fork the repo and implement on your own. Note that, by forking the repo, you will miss new features and improvements we do in this repo and you will need a developer to backport the feature to your store. Finally, this list is a work in progress, so some features may be missing from both base.store starter and this list.

1. Support up to 2.5K SKUs. If you have more than 2.5K SKUs, you have two options. Either reduce the number of skus on your catalog to fall below 2.5K SKUs or use Client Side Rendering (CSR) for all SKUs. (Note that CSR makes your SKUs not indexable by Search Engines and harms performance considerably)
2. Multiple CMS Previews. Only one user is allowed to preview content from the CMS at a time. If two users preview any content from any page at the CMS, the previews are not consistent and one user may see data from the other.
3. Price Table
4. Regionalization
5. Internationalization
6. Shared Cart (Carrinho compartilhado)
7. Clear products that are our of stock from cart
8. GDPR (LGDP)
9. Shipping simulation
10. Sitemap
11. Sku selector on PDP
12. Promotions via utm
13. Produt specifications

🚀 Quick start

0. Clone this repo

   Get up and running by cloning this repo.

   # Clone this repo into your machine
   npx degit vtex-sites/base.store awesome.store

1. Install dependencies

   Install dependencies with yarn

   cd awesome.store/
   yarn

2. Setup store.config.js

   Choose the ecommerce platform provider of your choice in the store.config file and set the corresponding options. For instance, to connect to the VTEX platform on the store fashioneurope:

   module.exports = {
     platform: 'vtex',
   
     api: {
       storeId: 'fashioneurope'
       environment: 'vtexcommercestable'
     }
   }

3. Start developing

   Navigate into your new site’s directory and start it up.

   yarn develop

4. Open the source code and start editing!

   Your site is now running at http://localhost:8000!

Note: You'll also see a second link: http://localhost:8000/___graphql. This is a tool you can use to experiment with querying your data. Learn more about using this tool in the Gatsby tutorial. Also, if you want to query for dynamic data (allProducts, allCollections, search etc), you can use tools like GraphQL Playground and configure it to query http://localhost:8000/api/graphql

Open the `awesome.store` directory in your code editor of choice and edit `src/pages/index.tsx`. Save your changes and the browser will update in real-time!

🧑‍💻 Contributing

1. Keep the CHANGELOG updated We use a CHANGELOG to keep the history of all notable changes made to this repository. Each PR must have at least one entry on the [UNRELEASED] section of the CHANGELOG.md file.

🧐 What's inside?

A quick look at the top-level files and directories you'll see in a Gatsby project.

./
├── node_modules
├── src
├── .gitignore
├── .eslintignore
├── .prettierignore
├── .prettierrrc
├── .eslintrc
├── gatsby-config.js
├── gatsby-node.js
├── LICENSE
└── yarn.lock
├── package.json
├── tsconfig.json
├── store.config.js
├── README.md
├── CHANGELOG.md
├── __generated__
├── babel.config.js
├── cypress
├── cypress.json
├── gatsby-browser.js
├── gatsby-ssr.js
├── lighthouserc.js
├── public
├── pull_request_template.md
├── renovate.json

1. /node_modules: This directory contains all of the modules of code that your project depends on (npm packages) are automatically installed.

2. /src: This directory will contain all of the code related to what you will see on the front-end of your site (what you see in the browser) such as your site header or a page template. src is a convention for “source code”.

3. .gitignore: This file tells git which files it should not track / not maintain a version history for.

4. .prettierrc: This is a configuration file for Prettier. Prettier is a tool to help keep the formatting of your code consistent.

5. .eslintrc.js: This is a configuration file for ESLint. ESlint is a tool to find and fix problems in your JavaScript code.

6. gatsby-config.js: This is the main configuration file for a Gatsby site. This is where you can specify information about your site (metadata) like the site title and description, which Gatsby plugins you’d like to include, etc. (Check out the config docs for more detail).

7. gatsby-node.js: This file is where Gatsby expects to find any usage of the Gatsby Node APIs (if any). These allow customization/extension of default Gatsby settings affecting pieces of the site build process.

8. LICENSE: Gatsby is licensed under the MIT license.

9. yarn.lock (See package.json below, first). This is an automatically generated file based on the exact versions of your npm dependencies that were installed for your project. (You won’t change this file directly).

10. package.json: A manifest file for Node.js projects, which includes things like metadata (the project’s name, author, etc). This manifest is how npm knows which packages to install for your project.

11. tsconfig.json: The configuration file for the typescript compiler. This will statically analyze your code for errors and bugs before releasing them into production

12. store.config.js: Configure your e-commerce platform, default sales channel etc.

13. README.md: A text file containing useful reference information about your project.

14. CHANGELOG.md: A text file containing all notable changes to the project.

15. __generated__: Where TypeScript typings are generated for your GraphQL queries. You can use these files for strongly typing your App

16. babel.config.js: Babel configurations for you app. This is where you can change the targeted browsers.

17. cypress: End to End(e2e) tests using Cypress. Most of the scenarios are covered here. Add your custom flows to avoid regressions

18. cypress.json: Cypress configuration file

19. gatsby-browser.js: Lets you respond to Gatsby-specific events within the browser, and wrap your page components in additional global components. The Gatsby Browser API gives you many options for interacting with the client-side of Gatsby. More info at: https://www.gatsbyjs.com/docs/reference/config-files/gatsby-browser/

20. gatsby-ssr.js: Lets you respond to Gatsby-specific events during SSG and SSR, and wrap your page components in additional global components. More info at: https://www.gatsbyjs.com/docs/reference/config-files/gatsby-ssr/

21. lighthouserc.js: Configures Google Lighthouse CI. This is where you can turn on/off lighthouse assertions to be used by Lighthouse CI Bot/hook

22. pull_request_template.md: Template used when creating your Pull Requests

23. renovate.json: Renovate configuration file to keep your store always fresh with Faststore's latest versions

24. .prettierignore: Ignore listed files when applying prettier rules

25. .eslintignore: Ignore listed files when applying eslint rules

💻 Code Structure

All code is inside the src folder. The code is split into folders that implement an MVC-like architecture.

The controller is inside the src/sdk folder. This is where you will find most logic for the application. This folder contains hooks for adding items to cart, making graphql queries, resizing images, etc. If you need to write a custom business logic this is probably the place to put this logic.

The views are written in the src/components folder and are subdivided into domain-specific components. Cart related items are inside the src/components/cart folder. Search and Product related components like facets, product summary, and search results are in their respective folders. Basic building blocks components are inside the UI folder. Components like button, checkbox, and modal are good candidates for the UI folder. Section components are those components that occupy a whole slice on the webpage and are desirable to be changed by a CMS. Section components are Product Gallery, Carousel, Shelf and Product description.

The model, in a website, is where the data fetching occurs. Since this project uses Jamstack, a crucial design decision was made to explicitly split where Static and Dynamic data are fetched. The files inside the src/pages folder use Gatsby's File System Route API to declare routes and fetch static data. The files inside the src/views folder revalidate and enrich static data with dynamic attributes.

To summarize:

1. src/pages: Routes are declared and static data is fetched.
2. src/views: Receives static data from src/pages, enriches this data with dynamic attributes, and render section components along with SEO tags.
3. src/components/sections: Receives necessary data and use domain-specific components (cart/product/search/ui) for rendering a slice on the web page.

✏️ Adding Components

What better than an example for learning the best practices while adding components? In this example, we will add a button component. Components live on the src/components folder. Each component may have, at most, 3 files: a component file, an export file, and a styling file. First, let's create a folder and the files.

mkdir src/components/ui/Button
touch src/components/ui/Button/Button.tsx
touch src/components/ui/Button/index.tsx

The index.tsx is just an export file, so its content is simple:

export { default } from './Button'

The real thing happens on Button.tsx. On this file let's define the component like:

import React from 'react'

interface Props {}

function Button(props: Props) {
  return <button {...props} />
}

export default Button

And, that's it! Now you have a working button that you can use anywhere on your project. Faststore, however, brings a handy library called @faststore/ui with built-in components to help you speed up your development. To use it, just change Button.tsx to:

import React from 'react'
import { Button as UIButton } from '@faststore/ui'
import type { ButtonProps } from '@faststore/ui'

interface Props extends ButtonProps {}

function Button(props: Props) {
  return <UIButton {...props} />
}

export default Button

Now, your Button component is powered by Store UI. However, if you try to use this on your app you will see that the button is lacking styles. To add styles, we will use CSS modules because they allow us to target data attributes. On your terminal, type:

touch src/components/ui/Button/button.scss

Now, on button.scss:

[data-store-button] {
  display: inline-flex;
  align-items: center;
  justify-content: center;
}

This data-store-button is a CSS data attribute selector. To know which selectors are available, check FastStore UI docs.

Now, open Button.tsx and import this CSS with:

import React from 'react'
import { Button as UIButton } from '@faststore/ui'
import type { ButtonProps } from '@faststore/ui'

import './button.scss'

interface Props extends ButtonProps {}

function Button(props: Props) {
  return <UIButton {...props} />
}

export default Button

For most components, you would stop here. However, buttons can have different variants. For instance, suppose you want to have a button component with primary and secondary variants. To add variants to the component, update Button.tsx:

import React from 'react'
import { Button as UIButton } from '@faststore/ui'
import type { ButtonProps } from '@faststore/ui'

import './button.scss'

interface Props extends ButtonProps {
  variant: 'secondary' | 'primary'
}

function Button({ variant, ...props }: Props) {
  return <UIButton data-button-variant={variant} {...props} />
}

export default Button

and then, on button.scss:

[data-store-button][data-button-variant='primary'] {
  background: blue;
}

[data-store-button][data-button-variant='secondary'] {
  background: pink;
}

You can also use classes, if you wanted to:

function Button({ variant, ...props }: Props) {
  return <UIButton className={variant} {...props} />
}

.primary[data-store-button] {
  background: blue;
}

.secondary[data-store-button] {
  background: pink;
}

Now we have a styled Button component that accepts different variants!! 🎉 The aforementioned guide works well for UI components. However, components like Navbar and Footer are more complex and usually don't have variants, since they usually serve a single responsibility on the page. For these cases, you can use BEM-Style CSS Syntax in SCSS like:

 // components/common/Navbar/Navbar.tsx
 ...
 function Navbar {
   return (
      <header className="navbar">
        <div className="navbar__header">
         <section className="navbar__row">
           <Button
               className="navbar__menu"
               aria-label="Open Menu"
           >
             <ListIcon size={32} />
           </Button>
         </section>
        </div>
      </header>
   )

🖊️ Styling Components

Our customized themes are based on Design Tokens using CSS Variables or a CSS class for each token. Today, we have the following files in the src/styles folder:

theme.scss

Here you'll find the basic structure to build your theme (font base, color palette, spacing, color-text, body background color...), feel free to update it with your brand guidelines.

Colors

We suggest using a color palette of 3 colors and its gradation: primary, secondary and neutral.

We also listed a couple of customizable tokens so you can easily change your body background, for example.

If you feel the need to edit some of the color decisions, you can enter colors.scss and update the semantical tokens. E.g.:

--color-border-input: var(--color-neutral-4); // Current
--color-border-input: var(--color-neutral-5); // Updated

Typography

We use the Modular Scale setting to create our text-sizes. If you want to change it, just set the base-font-size and the scale ratio.

Spacing

The spacing scale is based on rem sizes, so it will remain consistent if you change the base-font-size.

grid.scss

List of classes used to create default page grid.

.grid-content-full // Should be used for sections that are side to side, generally with a colored background.
.grid-content // Should be used for sections that fit centered on the grid.
.grid-section // This class only adds default vertical margins for page sections.

typography.scss

For the typography-related tokens, we decided to use classes to add extra stylings like font-weight and line-height. In this file, you'll see all the classes for titles, paragraphs, and default settings on the body. You can create new ones here if needed.

🍒 Adding queries

We use graphql-codegen to pre-process GraphQL queries. This compilation generates TypeScript typings and configurations for our graphql server under the folder @generated/graphql. This means we can staticaly analyse your code in search of bugs and secure your graphql server before each deploy. If, however you need to change any GraphQL Fragment, Query or Mutation, you will need to regenerate the whole thing. To do this, open your terminal and type

$ yarn develop

Now, after the gatsby development server is up and running, open another terminal and run

$ yarn generate

That's it! you have just regenerated all graphql queries/fragments for your application and the new data you requested should be available to your component.

Pro tip: Pass -w to the yarn generate command so it watches for changes and you don't need to run this command multiple times

🎓 Learning the Frameworks

Looking for more guidance? Full documentation for Faststore lives on this GitHub repository. Also, for learning Gatsby, take a look at the Gatsby Website, they have plenty of tutorials and examples in there.

⚡ Performance & QA

This project has strict performance budgets. Right out of the box, this project performs around 95 on Google's Page Speed Insights website, which usually is way more strict than your laptop's chrome lighthouse. Every time you commit to the repository, our QA bots will run and evaluate your code quality. We recommend you NEVER put in production a code that breaks any of the bots. If a bot breaks and still you need to put the code into production, change the bot config (lighthouserc.js, cypress.json) to make it pass and merge. This way you ensure your website will keep performing well during the years to come.

Lazy loading components

According to Gatsby:

loadable-components is the recommended lazy-loading solution for all server-side-rendered React applications, including Gatsby websites.

So First, try to use the native lazy/Suspense alternative. But if there is some Server Side Rendered dependency, switch to using the loadable-components.

Finally, for that pages that can use both lazy and loadable, keep the preference to use only loadable for the sake of avoiding loading two different things for the same purpose.

Adding third party scripts

Adding third-party scripts to a webpage usually makes it slow. To maintain great performance while third-party scripts are added, this project uses Partytown, a lazy-load library that helps relocate intensive scripts into a web worker and off of the main thread.

To add scripts using Partytown, add the type="text/partytown" to the script tag and make sure to add it before the Partytown script or component. Some third-party scripts execute expensive computations that may require some time to run, making pages few slow. If that's the case, wrap those in a function and reference it on the Partytown forward prop. By doing this, Partytown will run this function on a web worker so it doesn't block the main thread.

export const onRenderBody = ({ setHeadComponents }) => {
  // ...
  setHeadComponents([
    <script type="text/partytown">
      window.expensiveFunction = function() {/* expensive computation used by custom-script */}
    </script>
    <script key="custom-script" src="*://domain/path" type="text/partytown" />,
    <Partytown key="partytown" forward={["expensiveFunction"]} />
  ])
  // ...
}

For more information about integrating third-party scripts: Partytown Wiki