This is a React NextJS template for Prismic with Slice Machine.
This template contains the bare basics needed to setup a prismic repo with dynamic pages and slicemachine. All with examples to show of everything needed. Includes SEO, PWA, GTAG and protection on non production environments.
Main dependencies used:
- React
- Next.js
- Typescript (dev)
- Prismic
- Styled components
- Eslint (dev)
- Prettier (dev)
Other dependencies:
Change following variables with your own, for easy of use {{variableName}} is used to easily find them.
| Name | Description | file | example |
|---|---|---|---|
prismicRepo |
The repo name of your prismic project | sm.json |
prismic-repo-1 |
Other important information that needs changing:
- Repository config in
package.json: everything needed for your repository. Things like name, description and repository URL - SEO in
next-seo.config.js: this is the default SEO data, if not provided in prismic. If you do not like hard coding default data, remove this file. This includes theog-image.jpgin/public - Theme in
theme.ts: this contains the styled components theme you will be working with. - Fonts in
_documents.tsx: include the font you want in the<Head>tags - Favicon stuff in
/public: this includes the favicon icons and manifest.json
Add following ENV variables to a file in the root names: env.local
| Name | Description |
|---|---|
GA_TRACKING_ID |
Google Analytics tracking ID |
First, make sure to set the prismicRepo, then install the dependencies:
npm installAfter, run the development server:
npm run devOpen http://localhost:3000 with your browser to see the result.
Then run slicemachine server:
npm run smOpen http://localhost:9999 to see the slicemachine interface.
BSD 3-Clause License
Copyright (c) 2021, Diemas All rights reserved.
Redistribution and use in source and binary forms, with or without modification, are permitted provided that the following conditions are met:
-
Redistributions of source code must retain the above copyright notice, this list of conditions and the following disclaimer.
-
Redistributions in binary form must reproduce the above copyright notice, this list of conditions and the following disclaimer in the documentation and/or other materials provided with the distribution.
-
Neither the name of the copyright holder nor the names of its contributors may be used to endorse or promote products derived from this software without specific prior written permission.
THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.