# @garyblackwood/next-starter > A starter template for Next.js web applications. Latest version **0.1.4** (published 2021-08-14) · MIT license · 0 weekly downloads ## Install ```sh npm install @garyblackwood/next-starter pnpm add @garyblackwood/next-starter yarn add @garyblackwood/next-starter bun add @garyblackwood/next-starter ``` Provides the command `next-starter`. ## Health **Score 15/100 (F)** — status: abandoned. Positive: no vulnerabilities. Warnings: low downloads; no types; no esm support; pre 1.0. Negative: abandoned; low maintenance score. ## Facts | | | |---|---| | Version | 0.1.4 | | Published | 2021-08-14 | | First published | 2021-06-23 | | Weekly downloads | 0 | | License | MIT | | TypeScript types | none | | Module format | CommonJS | | Dependencies | 10 | | Unpacked size | 433 KB | | Known vulnerabilities | 0 (+16 in 2 direct dependencies) | | Install scripts | no | | Author | Gary Blackwood | | Maintainers | garyblackwood | | Keywords | Next.js, starter, template | ## Links - npm: https://www.npmjs.com/package/@garyblackwood/next-starter - Repository: https://github.com/Garee/next-starter - Issues: https://github.com/Garee/next-starter/issues - npm.io page: https://npm.io/package/@garyblackwood/next-starter ## Dependencies (10) - [next](https://npm.io/package/next.md) 11.1.0 - [react](https://npm.io/package/react.md) 17.0.2 - [remark](https://npm.io/package/remark.md) 13.0.0 - [date-fns](https://npm.io/package/date-fns.md) 2.22.1 - [next-pwa](https://npm.io/package/next-pwa.md) 5.2.21 - [react-dom](https://npm.io/package/react-dom.md) 17.0.2 - [classnames](https://npm.io/package/classnames.md) 2.3.1 - [gray-matter](https://npm.io/package/gray-matter.md) 4.0.3 - [remark-html](https://npm.io/package/remark-html.md) 13.0.1 - [netlify-identity-widget](https://npm.io/package/netlify-identity-widget.md) 1.9.1 ## Alternatives - [lodash.startswith](https://npm.io/package/lodash.startswith.md) — 769.7K weekly downloads - [@tarojs/service](https://npm.io/package/@tarojs/service.md) — 33.9K weekly downloads - [io.extendreality.tilia.indicators.spatialtargets.unity](https://npm.io/package/io.extendreality.tilia.indicators.spatialtargets.unity.md) — 131 weekly downloads - [@rtarojs/taro](https://npm.io/package/@rtarojs/taro.md) — 90 weekly downloads - [node-branch-io](https://npm.io/package/node-branch-io.md) — 50 weekly downloads ## Recent versions - 0.1.4 (latest) — 2021-08-14 - 0.1.3 — 2021-08-07 - 0.1.2 — 2021-08-07 - 0.1.1 — 2021-08-07 - 0.1.0 — 2021-06-24 - 0.0.0 — 2021-06-23 ## README # next-starter This is a [Next.js](https://nextjs.org/) project bootstrapped with [`create-next-app`](https://github.com/vercel/next.js/tree/canary/packages/create-next-app). After bootstrapping, the following was added: - [TypeScript](https://www.typescriptlang.org/) support for modern ECMAScript features. - The files `.env.{development,production}` to set environment variables. - [Prettier](https://prettier.io/) for code formatting. - [SCSS](https://sass-lang.com/) support for modern CSS features. - [Stylelint](https://stylelint.io/) for linting `.scss` files.cla - The [`classnames`](https://github.com/JedWatson/classnames) library to conditionally join `className` values. - [`commitlint`](https://commitlint.js.org/#/) to enforce [conventional commit](https://www.conventionalcommits.org) messages. - [`husky`](https://typicode.github.io/husky/#/) and [`lint-staged`](https://github.com/okonet/lint-staged) to automatically trigger linting before commits. - A simple example blog application. - Custom `404` and `500` error pages. - A [development container](https://code.visualstudio.com/docs/remote/create-dev-container). - Progress Web App support using [`next-pwa`](https://github.com/shadowwalker/next-pwa). - [Jest](https://jestjs.io/) and [react-testing-library](https://github.com/testing-library/react-testing-library) for testing. - [Netlify CMS](https://www.netlifycms.org/) for content management. - [Travis CI](https://travis-ci.com) configuration. ## Getting Started First, clone and install the dependencies: ```bash npx @garyblackwood/next-starter my-app cd my-app npm run install ``` Next, run the development server: ```bash npm run dev ``` Open [http://localhost:3000](http://localhost:3000) with your browser to see the result. To start the CMS server: ```bash npm run cms-server ``` To perform static analysis: ```bash npm run lint ``` To run tests: ```bash npm test ``` To build for production: ```bash 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 `` 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 | Directory | Description | | ------------- | ----------------------------------------------- | | \_\_tests\_\_ | The Jest unit tests. | | .devcontainer | The development docker container configuration. | | .husky | The git hooks scripts. | | components | The app's reusable components. | | lib | The app's service-like code. | | package | Contains the package installation script. | | pages | The app's page components. | | posts | The markdown files for each example blog post. | | public | Services static content from the root /. | | styles | The app's CSS. | ## Learn More To learn more about Next.js, take a look at the following resources: - [Next.js Documentation](https://nextjs.org/docs) - learn about Next.js features and API. - [Learn Next.js](https://nextjs.org/learn) - an interactive Next.js tutorial. --- _Source: https://npm.io/package/@garyblackwood/next-starter · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._