README.md

Tailnext

Tailnext is a free and open-source template to make your website using NextJS + Tailwind CSS. Ready to start a new project and designed taking into account best practices.

Features

• ✅ Integration with Tailwind CSS supporting Dark mode.
• ✅ Production-ready scores in Lighthouse and PageSpeed Insights reports.
• ✅ Image optimization and Font optimization.
• ✅ Fast and SEO friendly blog.
• ✅ Generation of project sitemap and robots.txt based on your routes.

Table of Contents

• Demo
• Getting started
  • Project structure
  • Commands
  • Configuration
  • Deploy
• Roadmap
• Contributing
• Acknowledgements
• License

Demo

📌 https://tailnext.vercel.app/

Getting started

• Clone: git clone https://github.com/onwidget/tailnext.git
• Enter in the directory: cd tailnext
• Install dependencies: npm install
• Start the development server: npm run dev
• View project in local environment: localhost:3000

Project structure

Inside Tailnext template, you'll see the following folders and files:

/
├── .storybook/
├── app/
│   ├── (blog)
│   │   ├── [slug]
|   |   |   └── page.js
|   |   └── blog
|   |       └── page.js
│   ├── head.js
│   ├── layout.js
│   └── page.js
├── public/
│   └── favicon.svg
├── src/
│   ├── assets/
│   │   ├── images/
|   |   └── styles/
|   |       └── base.css
│   ├── components/
│   │   ├── atoms/
|   |   └── widgets/
|   |       ├── Header.astro
|   |       ├── Footer.astro
|   |       └── ...
│   │── content/
│   |   └── blog/
│   |       ├── demo-post-1.md
│   |       └── ...
│   ├── stories/
│   ├── utils/
│   └── config.mjs
├── package.json
└── ...

Seasoned next.js expert? Delete this file. Update config.mjs and contents. Have fun!

Commands

All commands are run from the root of the project, from a terminal:

Command	Action
npm install	Install dependencies
npm run dev	Starts local dev server at localhost:3000
npm run build	Build your production site to ./dist/
npm run preview	Preview your build locally, before deploying
npm run storybook	Open storybook to view stories by widgets
npm run format	Format codes with Prettier
npm run lint:eslint	Run Eslint

Configuration

Coming soon ..

Deploy

Deploy to production (manual)

You can create an optimized production build with:

npm run build

Now, your website is ready to be deployed. All generated files are located at dist folder, which you can deploy the folder to any hosting service you prefer.

Deploy to Netlify

Clone this repository on own GitHub account and deploy to Netlify:

Deploy to Vercel

Clone this repository on own GitHub account and deploy to Vercel:

Roadmap

Coming soon ..

Contributing

If you have any idea, suggestions or find any bugs, feel free to open a discussion, an issue or create a pull request. That would be very useful for all of us and we would be happy to listen and take action.

Acknowledgements

Initially created by onWidget and maintained by a community of contributors.

License

Tailnext is licensed under the MIT license — see the LICENSE file for details.