aimdexter/Nextjs-Starter

Next.js minimal starter

NextJS Minimal Starter

Contents

• Developer experience first
• Features
• Philosophy
• Requirements
• Installation
• Development
• Deployment

Developer experience first:

• 🔥 Next.js for Static Site Generator
• 🎨 Integrate with Tailwind CSS
• 💅 PostCSS for processing Tailwind CSS
• ✏️ Linter with ESLint
• 🛠 Code Formatter with Prettier
• 🧪 Husky You can use it to lint your commit messages, run tests, lint code, etc... when you commit or push. Husky supports all Git hooks.
• 🧠 Commitlint helps your team adhere to a commit convention
• 📕 Storybook for building UI components and pages in isolation.
• 🆚 .vscode/settings.json specific settings that only apply to this project and Debugging support

Built-in feature from Next.js:

• ☕ Minify HTML & CSS
• 💨 Live reload
• ✅ Cache busting

Philosophy

• Minimal code
• SEO-friendly
• 🚀 Production-ready

Requirements

• Node.js and yarn

Installation

Clone repo:

git clone https://github.com/aimdexter/Nextjs_starter
cd Nextjs_starter

Make it your own:

rm -rf .git && git init && yarn init

Make it your own (windows users):

rmdir .git

ℹ️ This re-initializes the repo and sets up your project.

Install the dependencies:

yarn install

or

npm install

Development

Start a live-reload development server:

yarn dev

or

npm run dev

Generate a production build:

yarn build

or

npm run build

The generated HTML and CSS files are minified (built-in feature from Next js). It will also removed unused CSS from Tailwind CSS.

Deployment

▲ Deploy on Vercel

The easiest way to deploy your Next.js app is to use the Vercel Platform from the creators of Next.js.

Check out the Next.js deployment documentation for more details.

⊚ Deploy on Netlify

Click this button and it will help you create a new repo, create a new Netlify project, and deploy!

Contribution

I'm open to contributions & suggestions in making this a lot better ✋

Made with ♥ by Aimade Anouar

License

MIT