Skip to content

Front-end template with nextjs, typescript, styled-componentes, jest react/testing libarary, prettier, ESLint, husky, pre-commit, pre-push, github actions and patterns

Notifications You must be signed in to change notification settings

gabrielduete/frontend-template-nextjs

Repository files navigation

TEMPLATE NEXTJS

This template was created in order to speed up the setup settings in nextjs typescript projects, with some standardization settings, such as eslint, prettier, husky, pre-commit, pre-push, github actions and patterns

Technologies 🛠️

How to use 🧑‍💻

1. Click on button "Use this repository", then "Create a new repository"

image

2. Create your repository

image

3. Clone your repository

image

4. Run yarn to install dependencies

image

🎉 Done! You can start working now!

Optional patterns 📋

The folders src and pages came with a pattern, but they can be removed or edited if you want!

image

How to contribute 📌

Good! You can contribute in two ways: Creating pull requests with some additional configuration (don't forget to write good documentation in PR) or creating issues!

First organize the setup:

  1. Fork the project
  2. Go to the fork repository on your github and in the code part copy the link to clone (HTTPS or SSH)
  3. Open the terminal and choose a folder you like and do a git clone paste the link you copied
  4. Create a branch: git checkout -b <name_branch>.
  5. Make the changes and confirm: git commit -m '<message_commit>'
  6. Send to original repository: git push origin <main_branch> / <local>
  7. Create pull request
  8. Now just wait for the review!

Thanks in advance for contributing! ❤️