0.1.4 • Published 3 years ago

@garyblackwood/next-starter v0.1.4

Weekly downloads
-
License
MIT
Repository
github
Last release
3 years ago

next-starter

This is a Next.js project bootstrapped with create-next-app.

After bootstrapping, the following was added:

Getting Started

First, clone and install the dependencies:

npx @garyblackwood/next-starter my-app
cd my-app
npm run install

Next, run the development server:

npm run dev

Open http://localhost:3000 with your browser to see the result.

To start the CMS server:

npm run cms-server

To perform static analysis:

npm run lint

To run tests:

npm test

To build for production:

npm run build

Customisation Checklist

Run through this checklist to customise the application for your needs:

  • Update the name, description, homepage, repository, keywords and bugs fields in package.json.
  • Update site metadata within the <Head> component in components/layout.tsx.
  • Update the application configuration in lib/config.ts.
  • Update name, short_name, theme_color and background_color in public/site.webmanifest.
  • Replace public/favicon.ico and public/icon.png etc.
  • Update the environment variables in .env.{development,production}.
  • Remove unnecessary dependencies from package.json e.g. gray-matter, remark, remark-html, date-fns
  • Change the license in package.json and LICENSE if needed.
  • Update the CMS configuration in public/admin/config.yml.
  • Update the contents of this file.
  • Start working on your application!

Directory Overview

DirectoryDescription
__tests__The Jest unit tests.
.devcontainerThe development docker container configuration.
.huskyThe git hooks scripts.
componentsThe app's reusable components.
libThe app's service-like code.
packageContains the package installation script.
pagesThe app's page components.
postsThe markdown files for each example blog post.
publicServices static content from the root /.
stylesThe app's CSS.

Learn More

To learn more about Next.js, take a look at the following resources: