Skip to content

Latest commit

 

History

History
85 lines (62 loc) · 2.72 KB

README.md

File metadata and controls

85 lines (62 loc) · 2.72 KB
landing project

Content


📌 Contents


👋 introduction

Simple project that creates a QR code. Created at the request of a friend of mine who has a business and complained about it taking too long to open the cell phone application that has pix, enter the password, create a qrcode, put it on the screen and show it to the client. Or the simple fact that he had to read the pix key out loud to the customer, which also took some time, and then the customer would enter the value and have to show a receipt to see if everything was ok. The purpose of this application is to make this process faster and simpler. The evolution of this MVP includes creating even faster alternatives for carrying out this simple process. That's why I invite you to think with me about how to make this even faster.

🏃💨 Starting

Before starting, make sure you meet the following requirements:

[🫡 node 18.x]

git clone https://github.com/Thiago-Mota-Santos/pagarmepix.git

1.Install packages

yarn install

2.Fill .env.example (In root folder)

yarn copy-env

4.Start Aplication (In root folder)

yarn dev

⚒️ Stack

  1. NextJS
  2. TailwindCSS
  3. Firebase

🤝 Contributing

contributions are amazing, to contribute follow these steps:

  1. Fork the project repository.

  2. Clone the repo using git clone.

  3. Create a new branch with a descriptive name (e.g., amazing-new-feature or fix-issue-3).

git checkout -b new-feature-branch
  1. Make your changes and commit then in new branch with a description name
git commit -m 'feat: bug fixed'

PS..: You can use conventional commits, to make more semantic and descriptive name changes https://www.conventionalcommits.org/en/v1.0.0/

  1. Push your changes to your forked repository using the following command:
git push origin new-feature-branch

📫 Media


(back to top)