{"id":13630147,"url":"https://github.com/UseAllFive/next-prismic-base","last_synced_at":"2025-04-17T13:31:35.508Z","repository":{"id":37517965,"uuid":"285637142","full_name":"UseAllFive/next-prismic-base","owner":"UseAllFive","description":"Use All Five's starter kit for Next.js and Prismic.","archived":false,"fork":false,"pushed_at":"2023-01-28T15:15:49.000Z","size":1967,"stargazers_count":11,"open_issues_count":1,"forks_count":1,"subscribers_count":8,"default_branch":"production","last_synced_at":"2025-04-14T06:55:32.028Z","etag":null,"topics":["nextjs","prismic"],"latest_commit_sha":null,"homepage":"https://next-prismic-base.vercel.app","language":"JavaScript","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/UseAllFive.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null}},"created_at":"2020-08-06T17:58:07.000Z","updated_at":"2024-07-22T00:23:18.000Z","dependencies_parsed_at":"2023-02-15T17:15:56.163Z","dependency_job_id":null,"html_url":"https://github.com/UseAllFive/next-prismic-base","commit_stats":null,"previous_names":[],"tags_count":0,"template":true,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/UseAllFive%2Fnext-prismic-base","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/UseAllFive%2Fnext-prismic-base/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/UseAllFive%2Fnext-prismic-base/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/UseAllFive%2Fnext-prismic-base/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/UseAllFive","download_url":"https://codeload.github.com/UseAllFive/next-prismic-base/tar.gz/refs/heads/production","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":249344810,"owners_count":21254740,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["nextjs","prismic"],"created_at":"2024-08-01T22:01:31.657Z","updated_at":"2025-04-17T13:31:35.488Z","avatar_url":"https://github.com/UseAllFive.png","language":"JavaScript","funding_links":[],"categories":["JavaScript"],"sub_categories":[],"readme":"# YOUR_PROJECTS_NAME_HERE\n\n## About the project\n\n**Full name:** Not Just The Acronym\n\n**Current/old website:** www.example.com\n\n**Description:** A little description about the client/project\n\n**Designs:** www.figma.com/abc\n\n**Sitemap:** www.figma.com/file/4nN9qgqFVHYqlabovASf8E/Sitemap-Template (\u003c to duplicate + adjust for current project)\n\n## What you need to know\n\nIt's highly suggested that you read through the Next and Prismic documentation below before starting\n\n- [Next.js](https://nextjs.org/)\n- [Prismic](https://prismic.io/)\n\nUA5 has also put together a [playlist of videos](https://www.youtube.com/playlist?list=PLR2sMJTX0y3FemVvbjp-rGlTALEth-Si9) that provide a bird's eye view our toolset.\n\n## Already connected to Prismic?\n\nIf you have not yet connected this codebase to Prismic [carefully read through the instructions here](https://github.com/UseAllFive/next-prismic-base/wiki). Otherwise, you can probably skip those instructions and simply read the following to get the project up and running locally:\n\n## Configuration\n\n### Set up environment variables\n\nGet 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.\n\n### Install deps, run development server\n\nYou 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)](https://github.com/nvm-sh/nvm).\n\n```\nnvm use\n```\n\nThis project uses the [yarn package manager](https://yarnpkg.com/). To begin development, run the following commands, which will install dependencies and run the development server.\n\n```bash\nyarn\nyarn dev\n```\n\nYour site should be up and running on [http://localhost:3000](http://localhost:3000)!\n\n## Managing data\n\nThe CMS for this site is [hosted on Prismic](https://prismic.io).\n\n## File Structure Organization\n\n### Components Directory\n\nThe components directory is where you'll be creating the component templates that form your site. The directory is broken up into four subdirectories:\n\n1. **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.\n2. **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.\n3. **Slices**. These should correspond directly with your prismic slices.\n4. **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.\n\n## Storybook\n\nThis 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.\n\n## Deploying\n\nThis site is [hosted on vercel](https://vercel.com/). 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.\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2FUseAllFive%2Fnext-prismic-base","html_url":"https://awesome.ecosyste.ms/projects/github.com%2FUseAllFive%2Fnext-prismic-base","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2FUseAllFive%2Fnext-prismic-base/lists"}