https://github.com/gabrielduete/frontend-template-nextjs

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

eslint front-end front-end-development frontend github-actions husky jest nextjs patterns pre-commit pre-push prettier react styled-components template template-frontend template-project testing-library typescript

Last synced: about 2 months ago
JSON representation

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

• Host: GitHub
• URL: https://github.com/gabrielduete/frontend-template-nextjs
• Owner: gabrielduete
• Created: 2022-08-30T04:26:24.000Z (over 2 years ago)
• Default Branch: main
• Last Pushed: 2024-03-28T09:16:31.000Z (9 months ago)
• Last Synced: 2024-08-01T21:57:05.343Z (5 months ago)
• Topics: eslint, front-end, front-end-development, frontend, github-actions, husky, jest, nextjs, patterns, pre-commit, pre-push, prettier, react, styled-components, template, template-frontend, template-project, testing-library, typescript
• Language: TypeScript
• Homepage:
• Size: 1.97 MB
• Stars: 3
• Watchers: 1
• Forks: 0
• Open Issues: 9
• Metadata Files:
  • Readme: README.md

Awesome Lists containing this project

README

        
# 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 🛠️

- [Nextjs](https://nextjs.org/)

- [Typescript](https://www.typescriptlang.org/)

- [Styled-componentes](https://styled-components.com/)

- [Jest](https://jestjs.io/)

- [React/Testing Libarary](https://testing-library.com/docs/react-testing-library/intro/)

- [Prettier](https://prettier.io/)

- [ESLint](https://eslint.org/)

- [Husky](https://typicode.github.io/husky/#/)

- [Pre-commit](https://pre-commit.com/)

- [Pre-push](https://pre-commit.com/)

- [Github Actions](https://github.com/features/actions)

# How to use 🧑‍💻

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

![image](https://user-images.githubusercontent.com/59345698/226139998-06692707-b9ec-4d08-834e-643c9328f53f.png)

#### 2. Create your repository

![image](https://user-images.githubusercontent.com/59345698/226140008-27e530e4-23f7-41c9-a2d6-7c213514a13d.png)

#### 3. Clone your repository

![image](https://user-images.githubusercontent.com/59345698/226153270-c30ef952-6d62-4e25-bc8a-9d9c0b1ea170.png)

#### 4. Run `yarn` to install dependencies

![image](https://user-images.githubusercontent.com/59345698/226153341-72eddd0b-5427-427a-bb85-64a6e260dd69.png)

🎉 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](https://user-images.githubusercontent.com/59345698/226152304-5d26a9d3-d8d3-402c-b0bc-221418372163.png)

# 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

5. Create a branch: `git checkout -b `.

6. Make the changes and confirm: `git commit -m ''`

7. Send to original repository: `git push origin  / `

8. Create pull request

9. Now just wait for the review!

#### Thanks in advance for contributing! ❤️