This is a Next.js project bootstrapped with create-next-app
, utilising TypeScript to strongly check types/props and provide helpful intelisense, and the utility-first CSS framework Tailwind as the styling library and the headless CMS Prismic.
Prerequisites:
- Make sure you already have prismic account
To run this project, follow the instructions below:
- Open the terminal, and navigate the root directory for this project.
- Add in the environment variables in a
.env.development
file. More information found in the next section. - Run
npm install
, and wait for dependencies to install. - Run
npm run dev
oryarn dev
orpnpm dev
, where a local instance of this website will be initiated e.g localhost:3000 - Run
npm run slicemachine
, where a local instance of slicemachine will be initiated e.g localhost:9999
Open NextJS http://localhost:3000 with your browser to see the result. Open Slicemachine http://localhost:9999 with your browser to see the result.
There are a few environmental variables required to run this project. As mentioned previously, each website setup requires it's own .env.development
file within it's root directory.
The required variables are:
- PRISMIC_KEY: Found within the relevant project on our Prismic account
To learn more about Next.js, take a look at the following resources:
- Next.js Documentation - learn about Next.js features and API.
- Learn Next.js - an interactive Next.js tutorial.
You can check out the Next.js GitHub repository - your feedback and contributions are welcome!
The easiest way to deploy your Next.js app is to use the Vercel Platform from the creators of Next.js.
Check out our Next.js deployment documentation for more details.