Skip to content

Latest commit

 

History

History
72 lines (41 loc) · 3.61 KB

README.md

File metadata and controls

72 lines (41 loc) · 3.61 KB
Raw

YOUR_PROJECTS_NAME_HERE

About the project

Full name: Not Just The Acronym

Current/old website: www.example.com

Description: A little description about the client/project

Designs: www.figma.com/abc

Sitemap: www.figma.com/file/4nN9qgqFVHYqlabovASf8E/Sitemap-Template (< to duplicate + adjust for current project)

What you need to know

It's highly suggested that you read through the Next and Prismic documentation below before starting

UA5 has also put together a playlist of videos that provide a bird's eye view our toolset.

Already connected to Prismic?

If you have not yet connected this codebase to Prismic carefully read through the instructions here. Otherwise, you can probably skip those instructions and simply read the following to get the project up and running locally:

Configuration

Set up environment variables

Get a copy of the .env.local file from a UA5 colleague and add the file to the project root. Make sure that file is sent and received securely since this document will contain sensitive information that needs to remain hidden.

Install deps, run development server

You may run into issues if you're using a different node version than the one specified in the .nvmrc file. For this reason, it is recommended that you install that version with nvm (node version manager).

nvm use

This project uses the yarn package manager. To begin development, run the following commands, which will install dependencies and run the development server.

yarn
yarn dev

Your site should be up and running on http://localhost:3000!

Managing data

The CMS for this site is hosted on Prismic.

File Structure Organization

Components Directory

The components directory is where you'll be creating the component templates that form your site. The directory is broken up into four subdirectories:

  1. Layout. Here you will add global components which make up the layout of your site across all pages. The navigation, footer, grid, and any other component which could be considered "global" go here.
  2. Pieces. Repeatable pieces of the site that can be found across multiple components, such as a button or link. OR, a chunk of another component broken down, such as slideshow arrows or video overlay.
  3. Slices. These should correspond directly with your prismic slices.
  4. Templates. These will be called by whatever routes you've created under pages. So here you might have your base page template, plus a blog post template.

Storybook

This project has been configured w/ Storybook. While developing your components, run yarn storybook to start Storybook locally. Each of your components should come with a stories.js file, which will automatically add the component to Storybook. As part of the development process, developers should be creating stories in order to test your component in different viewports and edge-case scenarios having to do with different properties passed or not passeded to your component.

Deploying

This site is hosted on vercel. The master branch is associated with production. When master is pushed, the latest code will deploy to production automatically. For this reason, do not work directly off of the master branch. Only merge your code into master when you are ready to take the changes live.