Brazilian Worker

A tool for brazilian workers to help them with better understanding about your salary.

📋 Table of Contents

• 🚀 Features
• 🏗️ Build with
• 🏇 How to Use
• 👨‍💻 Development
  • 🧵 Code Styleguide
  • 📏 Branch and Commit Nomeclature
  • 🧪 Tests
  • 🙌 How to Contribute
• 🆘 Getting Help

🚀 Features

• Calculate CLT Liquid Salary

• Calculate PJ Liquid Salary

• Calculate Thirteen Salary

• Calculate Salary per Hour

• Compare CLT x PJ

• Compare PJ X CLT

  Coming Soon:

• Calculate Vacation Salary

• Calculate Retired Time

🏗️ Build with

• Python
• FastAPI
• Deta
• Typescript
• Angular
• Bootstrap
• Vercel

🏇 How to Use

To clone and run this application, you'll need Git and Docker installed on your computer. From your command line:

# Clone this repository
git clone https://github.com/heytorvas/brazilian-worker.git

# Access the project folder
cd brazilian-worker

# Run the application
docker-compose up --build &

👨‍💻 Development

🧵 Code Styleguide

To ensure that the project style guide is being followed, the pre-commit needs to be installed:

1. Install pre-commit

pip install pre-commit

2. Install hooks

pre-commit install

📏 Branch and Commit Nomeclature

Always create a new branch when adding a change to the project. Branch names show be preceded by the same prefixes as commit messages, depending on the type of change introduced. The prefix should be followed by a bar and then a name which briefly describes the change. The prefix list is located on this paper created by Angular Team.

A couple of example of branch names:

feat/new-feature-description

or

fix/bug-to-be-fixed

🧪 Tests

To run the tests, including unit and integration, run the following commands:

# With API running, access the container
docker-compose exec -it api bash

# Run the tests
python -m pytest tests/

🙌 How to Contribute

1. Clone this repository and create a new branch

git checkout https://github.com/heytorvas/brazilian-worker.git -b <NEW_BRANCH_NAME>

2. Make your changes and tests

3. Submit a pull request with comprehensive description of changes

🆘 Getting Help

If you have any questions, feel free to contact me on LinkedIn or, whether you prefer, open an issue on this repository.