From 2bb67822ad1e7237543ed2934d97158f215655a2 Mon Sep 17 00:00:00 2001 From: Tiago Gimenes Date: Mon, 25 Apr 2022 11:39:52 -0300 Subject: [PATCH 1/4] add nextjs starter --- README.md | 3 +- .../src/pages/starters/{base.js => gatsby.js} | 9 ++--- docs/src/pages/starters/nextjs.js | 33 +++++++++++++++++++ docs/static/data/starters.json | 9 +++-- 4 files changed, 47 insertions(+), 7 deletions(-) rename docs/src/pages/starters/{base.js => gatsby.js} (80%) create mode 100644 docs/src/pages/starters/nextjs.js diff --git a/README.md b/README.md index 84e01b275d..a5b61dd933 100644 --- a/README.md +++ b/README.md @@ -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. ## 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. diff --git a/docs/src/pages/starters/base.js b/docs/src/pages/starters/gatsby.js similarity index 80% rename from docs/src/pages/starters/base.js rename to docs/src/pages/starters/gatsby.js index 9ba9e59d14..94be6ad21e 100644 --- a/docs/src/pages/starters/base.js +++ b/docs/src/pages/starters/gatsby.js @@ -3,11 +3,12 @@ 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', @@ -15,15 +16,15 @@ const data = { '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 ( - + ); diff --git a/docs/src/pages/starters/nextjs.js b/docs/src/pages/starters/nextjs.js new file mode 100644 index 0000000000..a8bd8bb132 --- /dev/null +++ b/docs/src/pages/starters/nextjs.js @@ -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 ( + + + + ); +} + +export default STARTERS; diff --git a/docs/static/data/starters.json b/docs/static/data/starters.json index c127aea0b7..ec230bd9de 100644 --- a/docs/static/data/starters.json +++ b/docs/static/data/starters.json @@ -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", From 0035a76a84d227b0f8644c007c0c0f4b99c387c3 Mon Sep 17 00:00:00 2001 From: Tiago Gimenes Date: Mon, 25 Apr 2022 11:42:01 -0300 Subject: [PATCH 2/4] change base to gatsby on docs --- .../tutorials/cms-storecomponents/Overview.mdx | 6 +++--- .../03 - Creating your first SFJ store.mdx | 16 ++++++++-------- .../StarterSubmissionForm.jsx | 2 +- 3 files changed, 12 insertions(+), 12 deletions(-) diff --git a/docs/docs/tutorials/cms-storecomponents/Overview.mdx b/docs/docs/tutorials/cms-storecomponents/Overview.mdx index 953adbeca7..eb80528993 100644 --- a/docs/docs/tutorials/cms-storecomponents/Overview.mdx +++ b/docs/docs/tutorials/cms-storecomponents/Overview.mdx @@ -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). @@ -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) - \ No newline at end of file + diff --git a/docs/docs/tutorials/gatsby/03 - Creating your first SFJ store.mdx b/docs/docs/tutorials/gatsby/03 - Creating your first SFJ store.mdx index b74a5f17ed..2eb1b8fc63 100644 --- a/docs/docs/tutorials/gatsby/03 - Creating your first SFJ store.mdx +++ b/docs/docs/tutorials/gatsby/03 - Creating your first SFJ store.mdx @@ -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. -- 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) @@ -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/ ⠀ diff --git a/docs/src/pages/sections/StarterSubmissionForm/StarterSubmissionForm.jsx b/docs/src/pages/sections/StarterSubmissionForm/StarterSubmissionForm.jsx index 83655086d5..83dfe5583b 100644 --- a/docs/src/pages/sections/StarterSubmissionForm/StarterSubmissionForm.jsx +++ b/docs/src/pages/sections/StarterSubmissionForm/StarterSubmissionForm.jsx @@ -44,7 +44,7 @@ function StarterSubmissionForm() { Date: Mon, 25 Apr 2022 14:59:36 -0300 Subject: [PATCH 3/4] Apply suggestions from code review Co-authored-by: Igor Brasileiro --- README.md | 4 ++-- docs/docs/tutorials/cms-storecomponents/Overview.mdx | 2 +- .../tutorials/gatsby/03 - Creating your first SFJ store.mdx | 2 +- 3 files changed, 4 insertions(+), 4 deletions(-) diff --git a/README.md b/README.md index a5b61dd933..770b1a9dec 100644 --- a/README.md +++ b/README.md @@ -26,8 +26,8 @@ [Check out the docs](https://faststore.dev/quickstart) to quickstart from one of our official starters or create your own. ## Official Starters -- [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. +- [Gatsby](https://github.com/vtex-sites/gatsby.store): Basic starter with a generic store. +- [NextJS](https://github.com/vtex-sites/nextjs.store): Basic starter with a generic store. ## 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. diff --git a/docs/docs/tutorials/cms-storecomponents/Overview.mdx b/docs/docs/tutorials/cms-storecomponents/Overview.mdx index eb80528993..f20489770c 100644 --- a/docs/docs/tutorials/cms-storecomponents/Overview.mdx +++ b/docs/docs/tutorials/cms-storecomponents/Overview.mdx @@ -17,7 +17,7 @@ This tutorial is intended for those who started their FastStore project with the --- -> 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, check our [How-to guides](/how-to-guides) if you want to solve real-world issues. diff --git a/docs/docs/tutorials/gatsby/03 - Creating your first SFJ store.mdx b/docs/docs/tutorials/gatsby/03 - Creating your first SFJ store.mdx index 2eb1b8fc63..19ad1cdf70 100644 --- a/docs/docs/tutorials/gatsby/03 - Creating your first SFJ store.mdx +++ b/docs/docs/tutorials/gatsby/03 - Creating your first SFJ store.mdx @@ -12,7 +12,7 @@ In this part of the Tutorial, you will: - Clone our [**gatsby store**](https://github.com/vtex-sites/gatsby.store) to your local machine. - > 🔎 The **gatsby 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* containing only the most basic functionalities required to run a VTEX store. - Connect the **gatsby store** to your VTEX account in the `vtex.env` file. - Run a local development server at `http://localhost:8000/`. From 9c547674718b3562ee09e142ebd1eca4c107b9d7 Mon Sep 17 00:00:00 2001 From: Tiago Gimenes Date: Mon, 25 Apr 2022 15:05:06 -0300 Subject: [PATCH 4/4] change PR template --- .github/PULL_REQUEST_TEMPLATE.md | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/.github/PULL_REQUEST_TEMPLATE.md b/.github/PULL_REQUEST_TEMPLATE.md index c430946884..99b1ec5454 100644 --- a/.github/PULL_REQUEST_TEMPLATE.md +++ b/.github/PULL_REQUEST_TEMPLATE.md @@ -7,8 +7,8 @@ ## How to test it? -### `base.store` Deploy Preview - +### Starters Deploy Preview +