gutogalego / pixmeacoffee

---

📍 Table of Contents

• 👋 Introduction

• 🏎💨 Getting Started

  • ✅ Prerequisites
  • 💻 Installation

• 🤝 Contributing

• 📫 Contact

• 🙏 Acknowledgements

---

👋 Introduction

This repo serves as a central repository for all the project's code, documentation, and resources. It provides a collaborative platform for the project team to work together, share ideas, and contribute to the development of this critical project.

Pix me a coffee is a Brazilian repository, made by a brazilian for braz.. I guess u understood.

Pix is a tech that provides fast transactions between brazilians, so why not make easier donations by default and incentivate your favorite brazilian creator.

Welcome to Pix me a coffee.

---

🏎💨 Getting Started

✅ Prerequisites

Before you begin, ensure that you have the following prerequisites installed:

[📌 node 16.x]

💻 Installation

1. Clone the pixmeacoffee repository:

git clone https://github.com/bolodissenoura/pixmeacoffee

2. Change to the project directory:

cd pixmeacoffee

3. Install the dependencies:

npm install

4. Env:

• Create a .env ( use the .env.example as a example ) and fill in your Firebase config.

🤖 Running pixmeacoffee

npm run dev

---

🤝 Contributing

Contributions are always welcome! Please follow these steps:

1. Fork the project repository. This creates a copy of the project on your account that you can modify without affecting the original project.
2. Clone the forked repository to your local machine using a Git client like Git or GitHub Desktop.
3. Create a new branch with a descriptive name (e.g., new-feature-branch or bugfix-issue-123).

git checkout -b new-feature-branch

4. Make changes to the project's codebase.
5. Commit your changes to your local branch with a clear commit message that explains the changes you've made.

git commit -m 'Implemented new feature.'

6. Push your changes to your forked repository on GitHub using the following command

git push origin new-feature-branch

7. Create a pull request to the original repository. Open a new pull request to the original project repository. In the pull request, describe the changes you've made and why they're necessary. The project maintainers will review your changes and provide feedback or merge them into the main branch.

---

📫 Contact

If you have any questions or concerns, please open an issue on GitHub or contact the repo owner at linkedin [📌 @daniellimae]

---

🙏 Acknowledgements

[📌 Every brazilian creator <3 ]

---