Skip to content

Latest commit

 

History

History
62 lines (43 loc) · 2.26 KB

README.md

File metadata and controls

62 lines (43 loc) · 2.26 KB

Next.js TypeScript Starter

PRs welcome! License Follow @jpedroschmitz


A TypeScript starter for Next.js that includes all you need to build amazing projects 🔥

  • 📏 ESLint — Pluggable JavaScript linter
  • 💖 Prettier - Opinionated Code Formatter
  • 🐶 Husky — Use git hooks with ease
  • 📄 Commitizen - Conventional commit messages CLI
  • 🚓 Commitlint - Lint commit messages
  • 🖌 Renovate - Dependency update tool
  • 🚫 lint-staged - Run linters against staged git files
  • 👷 PR Workflow - Run Type Check & Linters on pull requests
  • 🗂 Absolute import - Import folders and files using the @ prefix
  • 🗂 Dotenv safe - ENforce environment variable
  • 🗂 Prisma - Lovely ORM
  • 🗂 Chakra-ui - Compoenent style libray

🚀 Getting started

The best way to start with this template is using create-next-app.

npx create-next-app ts-next -e https://github.com/jpedroschmitz/typescript-nextjs-starter

If you prefer you can clone this repository and run the following commands inside the project folder:

  1. npm install or yarn;
  2. yarn dev;

To view the project open http://localhost:3000.

🤝 Contributing

  1. Fork this repository;
  2. Create your branch: git checkout -b my-new-feature;
  3. Commit your changes: git commit -m 'Add some feature';
  4. Push to the branch: git push origin my-new-feature.

After your pull request is merged, you can safely delete your branch.

📝 License

This project is licensed under the MIT License - see the LICENSE.md file for more information.


Made with ♥ by João Pedro Schmitz