README.md

(project logo)

---> PROJECT NAME <---

Exemplo deste template em português brasileiro.

Table of contents

• 💻 Demo
• 🧾 Description
• 📖 Features
• 🔧 Tech stack
• 🚀 Running the project
  • Cloning the repository
  • Setting the environment variables
  • Requirements
  • Installing the dependencies
  • Running (development)
  • Building
  • Running (production)
• 🧪 Tests
  • Running the tests
• 📅 Coming next
• 🤝🏻 How to contribute
• 🙋‍♀️🙋‍♂️ Contributors
• 📝 License

💻 Demo

• What about recording some GIFs and taking some photos of your cool project?

🧾 Description

---> PROJECT NAME <--- has been built to make developers lives easier, by saving the time spent trying to write a good README for repositories.

Focus on what matters the most: your code.

📖 Features

With ---> PROJECT NAME <---, you can

• Schedule meetings
• Find your friends
• Enhance collaboration with your team
• Play cool games
• Crop images

🔧 Tech stack

• ReactJS
• Next.js
• TypeScript
• Next Auth
• React Query
• TailwindCSS
• zod
• React Hook Form

🚀 Running the project

Cloning the repository

Don't forget to change the values to match your repo!

## SSH
[email protected]:GGalupo/readme-template.git

## HTTPS
https://github.com/GGalupo/readme-template.git

## GitHub CLI
gh repo clone GGalupo/readme-template

• Is some environment variable needed to run the project?

Setting the environment variables

Before running the project, create a .env file at the root directory.

MY_ENV_VAR=
MY_ENV_VAR2=

You can get MY_ENV_VAR from ...

You can get MY_ENV_VAR2 from ...

Requirements

• Which are the requirements to run the project?

Example:

• Node.js v16.16.0+

...

Installing the dependencies

npm install

Running (development)

npm run dev

Building

npm run build

Running (production)

npm run start

Open http://localhost:3000 on your browser to see the project.

🧪 Tests

• Does your project have test automation?

This project has tests written using Jest and React Testing Library.

Running the tests

npm run test

📅 Coming next

• Which will be next implementations?

• Implement authentication
• Create a dark theme
• Follow ARIA rules on forms
• Add loading skeletons
• SEO optimizations
• Add animations on home page

🤝🏻 How to contribute

• Is this an open source project which allow people to contribute with it?

• Fork the repository
• On your GitHub account, clone the forked repository, like described on running the project section
• Create a branch and work on your changes

 git checkout -b my-amazing-feature

• Commit the changes you've worked on

git commit -m "feat: My changes"

• Push your changes to GitHub

git push origin my-amazing-feature

my-amazing-feature have to match the branch name you've created early on

• Go to the forked repo on GitHub and open a pull request

🙋‍♀️🙋‍♂️ Contributors

• Have someone contributed to build this awesome project?

ggalupo

📝 License

This project is under MIT license. See LICENSE.md for more details.