<h2>Overview</h2>
<p>This Next.js Boilerplate is a starter project that is set up with various technologies to enhance the development experience. It includes features such as Typescript, Chakra UI, Eslint, Prettier, Pre-commit (Husky + lint-staged), and Cypress. The boilerplate provides advantages offered by Next.js, supports styling with Chakra UI, and has a dark/light theme setup. It also includes type support through Typescript, code check and formatting through ESLint and Prettier, pre-commit checks through Husky and Lint-staged, and E2E and component testing with Cypress. With a minimal folder structure and SEO-friendly setup, this boilerplate offers productivity to your projects.</p>
<h2>Features</h2>
<ul>
<li><strong>All of Next's advantages (Live reload, SSR, SSG, native API...)</strong></li>
<li><strong>Styling with Chakra UI</strong></li>
<li><strong>Setup with dark/light theme support</strong></li>
<li><strong>Types support by Typescript</strong></li>
<li><strong>Code check and formatter by ESLint and Prettier</strong></li>
<li><strong>Pre-commit check by Husky and Lint-staged</strong></li>
<li><strong>E2E and Component testing with Cypress</strong></li>
<li><strong>Absolute imports (~)</strong></li>
<li><strong>Minimal folder structure</strong></li>
<li><strong>SEO friendly</strong></li>
</ul>
<h3>Automatic Installation</h3>
<ol>
<li>
<p>Install the create-next-js-boilerplate package:</p>
<pre><code>$ yarn create next-js-boilerplate
</code></pre>
<p>or</p>
<pre><code>$ npx create-next-js-boilerplate
</code></pre>
</li>
<li>
<p>Put Husky to work by running the following command:</p>
<pre><code>$ yarn husky-install
</code></pre>
<p>or</p>
<pre><code>$ npm run husky-install
</code></pre>
</li>
<li>
<p>Run the development server:</p>
<pre><code>$ yarn dev
</code></pre>
<p>or</p>
<pre><code>$ npm run dev
</code></pre>
</li>
</ol>
<h3>Manual Installation</h3>
<ol>
<li>
<p>Clone the repository:</p>
<pre><code>$ git clone https://github.com/AstrOOnauta/next-js-boilerplate.git
</code></pre>
</li>
<li>
<p>Install the project dependencies:</p>
<pre><code>$ yarn
</code></pre>
<p>or</p>
<pre><code>$ npm install
</code></pre>
</li>
<li>
<p>Put Husky to work by running the following command:</p>
<pre><code>$ yarn husky-install
</code></pre>
<p>or</p>
<pre><code>$ npm run husky-install
</code></pre>
</li>
<li>
<p>Run the development server:</p>
<pre><code>$ yarn dev
</code></pre>
<p>or</p>
<pre><code>$ npm run dev
</code></pre>
</li>
</ol>
<h3>Terminal Commands</h3>
<p>Here are some useful terminal commands provided by the Next.js boilerplate:</p>
<ul>
<li><code>dev</code>: runs your application on localhost:3000</li>
<li><code>build</code>: creates the production build version</li>
<li><code>start</code>: starts a simple server with the build production code</li>
<li><code>prettier</code>: runs the prettier commands in all components and pages</li>
<li><code>lint</code>: runs the lintering commands in all components and pages</li>
<li><code>lint-staged</code>: runs the linting &#x26; prettier commands to those files which are changed, not all project files</li>
<li><code>husky-install</code>: initialize Husky</li>
<li><code>type-check</code>: runs the linter in all components and pages</li>
<li><code>cypress:open</code>: runs Cypress on a browser to check E2E and component tests</li>
<li><code>cypress:run</code>: runs Cypress on a terminal to check E2E and component tests</li>
</ul>
<h2>Summary</h2>
<p>The Next.js Boilerplate is a comprehensive starter project for developers. It comes with various features and technologies such as Typescript, Chakra UI, ESLint, Prettier, Husky, Lint-staged, and Cypress. The boilerplate offers advantages provided by Next.js and supports efficient styling with Chakra UI. With an easy installation process and useful terminal commands, this boilerplate enhances productivity and provides a solid foundation for developing Next.js applications.</p>


<h2>Overview</h2>
<p>This Next.js Boilerplate is a setup that includes various tools and technologies such as Typescript, Chakra UI, Eslint, Prettier, Pre-commit (Husky + lint-staged), and Cypress. It aims to provide developers with a starting point for their projects and maximize their development experience. The boilerplate supports the latest version of Node.js and is compatible with macOS, Windows (including WSL), and Linux operating systems.</p>
<h2>Features</h2>
<ul>
<li><strong>All of Next's advantages (Live reload, SSR, SSG, native API...)</strong>: The boilerplate leverages the features and benefits provided by Next.js, including live reload, server-side rendering, static site generation, and access to native APIs.</li>
<li><strong>Styling with Chakra UI</strong>: Chakra UI is used for styling purposes, allowing developers to easily create visually appealing and responsive user interfaces.</li>
<li><strong>Setup with dark/light theme support</strong>: The boilerplate includes support for both dark and light themes, enabling developers to create applications with customizable themes.</li>
<li><strong>Types support by Typescript</strong>: Typescript is integrated into the boilerplate, providing type safety and improved code quality.</li>
<li><strong>Code check and formatter by ESLint and Prettier</strong>: ESLint and Prettier are used for code checking and formatting, ensuring consistent code style and identifying potential issues.</li>
<li><strong>Pre-commit check by Husky and Lint-staged</strong>: The boilerplate includes Husky and Lint-staged, which perform pre-commit checks to enforce code quality and prevent committing code that does not meet the defined standards.</li>
<li><strong>E2E and Component testing with Cypress</strong>: Cypress is integrated into the boilerplate to enable end-to-end (E2E) and component testing, ensuring the quality and reliability of the application.</li>
<li><strong>Absolute imports (~)</strong>: The boilerplate supports absolute imports using the <code>~</code> symbol, simplifying the import process and improving code readability.</li>
<li><strong>Minimal folder structure</strong>: The boilerplate follows a minimal folder structure, making it easy to navigate and organize code files.</li>
<li><strong>SEO friendly</strong>: The boilerplate is designed to be search engine optimization (SEO) friendly, allowing for better visibility and discoverability of the application.</li>
<li><strong>All productivity to your project</strong>: The boilerplate aims to enhance productivity by providing a set of tools and configurations that help streamline the development process.</li>
</ul>
<h3>Automatic Installation</h3>
<ol>
<li>Install the create-next-js-boilerplate by running the following command:</li>
</ol>
<pre><code class="language-bash">yarn create next-js-boilerplate
</code></pre>
<p>OR</p>
<pre><code class="language-bash">npx create-next-js-boilerplate
</code></pre>
<ol start="2">
<li>Set up Husky by running the following command:</li>
</ol>
<pre><code class="language-bash">yarn husky-install
</code></pre>
<p>OR</p>
<pre><code class="language-bash">npm run husky-install
</code></pre>
<ol start="3">
<li>Run the development server with the following command:</li>
</ol>
<pre><code class="language-bash">yarn dev
</code></pre>
<p>OR</p>
<pre><code class="language-bash">npm run dev
</code></pre>
<h3>Manual Installation</h3>
<ol>
<li>Clone the repository by running the following command:</li>
</ol>
<pre><code class="language-bash">git clone https://github.com/AstrOOnauta/next-js-boilerplate.git
</code></pre>
<ol start="2">
<li>Install dependencies by running the following command:</li>
</ol>
<pre><code class="language-bash">yarn
</code></pre>
<p>OR</p>
<pre><code class="language-bash">npm i
</code></pre>
<ol start="3">
<li>Set up Husky by running the following command:</li>
</ol>
<pre><code class="language-bash">yarn husky-install
</code></pre>
<p>OR</p>
<pre><code class="language-bash">npm run husky-install
</code></pre>
<ol start="4">
<li>Run the development server with the following command:</li>
</ol>
<pre><code class="language-bash">yarn dev
</code></pre>
<p>OR</p>
<pre><code class="language-bash">npm run dev
</code></pre>
<h2>Summary</h2>
<p>The Next.js Boilerplate is a comprehensive setup that provides developers with a foundation for building applications using Next.js. It includes features such as Typescript integration, Chakra UI for styling, ESLint and Prettier for code formatting and checking, Husky and Lint-staged for pre-commit checks, and Cypress for end-to-end and component testing. The boilerplate aims to enhance productivity and streamline the development process by offering a minimal folder structure, support for dark/light themes, and SEO-friendly configuration. Developers can choose between automatic and manual installation methods to set up the boilerplate and start building their projects with ease.</p>


Astroonauta

Next Js Boilerplate

Next Js Boilerplate