Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

chore: Add new starters on the docs #1240

Merged
merged 4 commits into from
Apr 25, 2022
Merged
Show file tree
Hide file tree
Changes from 2 commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
3 changes: 2 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -26,7 +26,8 @@
[Check out the docs](https://faststore.dev/quickstart) to quickstart from one of our official starters or create your own.

## Official Starters
- [Base](https://github.com/vtex-sites/base.store): Basic starter with generic store.
- [Gatsby](https://github.com/vtex-sites/gatsby.store): Basic starter with generic store.
- [NextJS](https://github.com/vtex-sites/nextjs.store): Basic starter with generic store.
tlgimenes marked this conversation as resolved.
Show resolved Hide resolved

## Learn
Check out our [Tutorials](https://faststore.dev/tutorials), [How-to Guides](https://faststore.dev/how-to-guides), [API References](https://faststore.dev/reference) and [Conceptual guides](https://faststore.dev/conceptual-guides) to deep dive in the world of building FastStores.
Expand Down
6 changes: 3 additions & 3 deletions docs/docs/tutorials/cms-storecomponents/Overview.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -10,14 +10,14 @@ import CardGrid from "@site/src/components/CardGrid/CardGrid"
# Overview

:::caution
This tutorial is intended for those who started their FastStore project with the Store Components starter. If you started your project with the Base Store starter, please refer to [this](/tutorials/cms-overview) tutorial.
This tutorial is intended for those who started their FastStore project with the Store Components starter. If you started your project with the Gatsby Store starter, please refer to [this](/tutorials/cms-overview) tutorial.
:::

*In this tutorial you'll learn how to integrate your FastStore project with **VTEX Headless CMS**, our preferred solution for content management.*

---

> This tutorial is designed for those who prefer to learn by doing. For a deeper understanding of the concepts in this section, you can check the [Concepts](/conceptual-guides) section. Instead, if you want to solve real-world issues, check our [How-to guides](/how-to-guides).
> This tutorial is designed for those who prefer to learn by doing. For a deeper understanding of the concepts in this section, you can check the [Concepts](/conceptual-guides) section. Instead, if you want to solve real-world issues, check our [How-to guides](/how-to-guides).
tlgimenes marked this conversation as resolved.
Show resolved Hide resolved

<CardGrid>

Expand All @@ -37,4 +37,4 @@ This tutorial is intended for those who started their FastStore project with the

[**7. Adapting the `views` components** Adapt your storefront components to consume data from our Headless CMS.](./7)

</CardGrid>
</CardGrid>
Original file line number Diff line number Diff line change
Expand Up @@ -10,24 +10,24 @@ sidebar_label: "2. Creating your first FastStore project"

In this part of the Tutorial, you will:

- Clone our [**base store**](https://github.com/vtex-sites/base.store) to your local machine.
- Clone our [**gatsby store**](https://github.com/vtex-sites/gatsby.store) to your local machine.

> 🔎 The **base store** is a boilerplate store theme with *no styling* that contains only the most basic functionalities required to run a VTEX store.
> 🔎 The **gatsby store** is a boilerplate store theme with *no styling* that contains only the most basic functionalities required to run a VTEX store.
tlgimenes marked this conversation as resolved.
Show resolved Hide resolved

- Connect the **base store** to your VTEX account in the `vtex.env` file.
- Connect the **gatsby store** to your VTEX account in the `vtex.env` file.
- Run a local development server at `http://localhost:8000/`.
- Make the first change in your store frontend.

## Step 1: Cloning the base store
## Step 1: Cloning the gatsby store

Clone the base store to your local machine by running the following command. Notice that your project name must end with `.store`.
Clone the gatsby store to your local machine by running the following command. Notice that your project name must end with `.store`.

```shell
npx degit vtex-sites/base.store {accountName}.store
npx degit vtex-sites/gatsby.store {accountName}.store
```

:::info
We strongly recommend using [degit](https://github.com/Rich-Harris/degit) to download only the latest commit from the *base store*. If the prompt displays **"Need to install the following packages: degit. Ok to proceed? (y)"**, enter **"y"**.
We strongly recommend using [degit](https://github.com/Rich-Harris/degit) to download only the latest commit from the *gatsby store*. If the prompt displays **"Need to install the following packages: degit. Ok to proceed? (y)"**, enter **"y"**.
:::

![](/img/tutorials/gatsby/npxdegitclone.png)
Expand Down Expand Up @@ -82,7 +82,7 @@ Let's check how our project looks like in a web browser so far.
This may take a few moments. Once your development server is ready, the command line will output the following message:

```shell
You can now view base.store in the browser.
You can now view gatsby.store in the browser.
http://localhost:8000/
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -44,7 +44,7 @@ function StarterSubmissionForm() {
<label htmlFor="GitHubRepo">Github repository URL</label>
<input
required
placeholder="https://github.com/vtex-sites/base.store"
placeholder="https://github.com/vtex-sites/gatsby.store"
type="url"
name="GitHubRepo"
value={GitHubRepo}
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -3,27 +3,28 @@ import Layout from '@theme/Layout';
import StarterComponentPage from '../sections/StarterComponentPage/StarterComponentPage'

const data = {
name: 'Base Store',
name: 'Gatsby Store',
owner: 'VTEX',
description:
'Kickoff your store with this boilerplate. This starter ships with the main FastStore configuration files you need to get up and running blazing fast.',
features: [
'Gatsby',
'Landing page',
'Product page',
'Intelligent search',
'Filters for categories',
'Optimistic shopping cart',
'Google Analytics',
],
demoURL: 'https://base.vtex.app/',
gitHubURL: 'https://github.com/vtex-sites/base.store',
demoURL: 'https://gatsby.vtex.app/',
gitHubURL: 'https://github.com/vtex-sites/gatsby.store',
price: 'Free',
img: '/img/starters/base-starter.png',
}

function STARTERS() {
return (
<Layout title="Base Starter">
<Layout title="Gatsby Starter">
<StarterComponentPage data={data} />
</Layout>
);
Expand Down
33 changes: 33 additions & 0 deletions docs/src/pages/starters/nextjs.js
Original file line number Diff line number Diff line change
@@ -0,0 +1,33 @@
import React from 'react';
import Layout from '@theme/Layout';
import StarterComponentPage from '../sections/StarterComponentPage/StarterComponentPage'

const data = {
name: 'NextJS Store',
owner: 'VTEX',
description:
'Kickoff your store with this boilerplate. This starter ships with the main FastStore configuration files you need to get up and running blazing fast.',
features: [
'NextJS',
'Landing page',
'Product page',
'Intelligent search',
'Filters for categories',
'Optimistic shopping cart',
'Google Analytics',
],
demoURL: 'https://nextjs.vtex.app/',
gitHubURL: 'https://github.com/vtex-sites/nextjs.store',
price: 'Free',
img: '/img/starters/base-starter.png',
}

function STARTERS() {
return (
<Layout title="NextJS Starter">
<StarterComponentPage data={data} />
</Layout>
);
}

export default STARTERS;
9 changes: 7 additions & 2 deletions docs/static/data/starters.json
Original file line number Diff line number Diff line change
@@ -1,8 +1,13 @@
[
{
"name": "Base Store",
"name": "Gatsby Store",
"imgPath": "/img/starters/base-store-thumbnail.png",
"url": "/starters/base"
"url": "/starters/gatsby"
},
{
"name": "NextJS Store",
"imgPath": "/img/starters/base-store-thumbnail.png",
"url": "/starters/nextjs"
},
{
"name": "CMS Base Store",
Expand Down