danielhesse / pagarme-challenge

Payment Service Provider (PSP) like Pagar.me with Node.js.

Pagar.me Challenge

This project refers to a challenge from Pagar.me for Software Engineer Backend.

The project is based on a super simplified version of a Payment Service Provider (PSP) like Pagar.me to learn a little more about how payments work in Brazil.

📌 Table of contents

• Features
• Technologies
  • Code standards

• Getting started
• How to run
• How to contribute to the project
• License

Features

• Processing debit and credit transactions
• List of transactions already created
• Creation of customer receivables/payables
• Customer balance inquiry

⚡ Technologies

This project was developed with the following technologies:

• Node.js
• TypeScript
• Jest
• SWC

🎈 Code standards

• EditorConfig

💻 Getting started

Before you begin, you will need to have the following tools installed on your machine:

• Git

The project can be built with npm or yarn, so choose one of the approach bellow in case you don't have any installed on your system.

Npm is distributed with Node.js which means that when you download Node.js, you automatically get npm installed on your computer.

• Node.js v16.14.2 or heigher.

Yarn is a package manager created by the Facebook team and seems to be faster than npm in general.

• Yarn v1.22.18 or heigher.

Also, it’s good to have an editor to work with the code like VSCode.

ℹ️ How to run

Follow the instructions below to download and use the project from this repository:

You can use yarn or npm as package manager to run this project, but preferably I use yarn.

Clone this repository using SSH:

git clone [e-mail]:danielhessell/pagarme-challenge.git

or clone using https:

git clone [e-mail]:danielhessell/pagarme-challenge.git

Go to project folder in terminal/cmd:

cd pagarme-challenge

Install dependencies:

yarn

As I am developing the project applying the TDD practice, it is possible to run only the tests of the application so far.

Run project:

yarn test

🎉 How to contribute to the project

1. Fork the project
2. Create a new branch with your changes: git checkout -b my-feature
3. Save the changes and create a commit message telling what you've done: git commit -m "feature: My new feature"
4. Submit your changes: git push origin my-feature

Caso tenha alguma dúvida confira este guia de como contribuir no GitHub.

📄 License

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

---

Made with 💙 by Daniel Hessel.