Table of Contents

1. Overview
   • Features
   • Technologies
2. Contributing
   • Reporting Bugs & Suggesting Enhancements
   • Fixing Issues
   • Setting Up Locally
3. Get in Touch

## Overview **_ContractorsUy_** is an open-source tool designed to help software developers in Uruguay transition from employees to independent contractors. It provides a detailed simulator and guide to help developers understand how taxes impact their earnings and how to optimize their financial strategies, whether they work for international or local companies. ### Features - Simulator: Estimate your optimal contractor's salary based on your current legal status and current salary as dependant employee. - Contractor's Guide: Detailed explanations of tax structures and legal considerations for the software industry. ### Technologies **Frontend:** - [TypeScript](https://www.typescriptlang.org/) - [React.js](https://react.dev/) - [Vite](https://vite.dev/) - [TailwindCSS](https://tailwindcss.com/) - [React Hook Form](https://react-hook-form.com/) - [Motion](https://motion.dev/) - [Aceternity UI](https://www.aceternity.com/components) - [Shadcn UI](https://ui.shadcn.com/) **DevOps & Analytics:** - [Vercel](https://vercel.com/) - [GitHub Actions](https://github.com/features/actions) - [PostHog](https://posthog.com/) **Scripting & Web Scraping:** - [Python](https://www.python.org/) - [BeautifulSoup](https://www.crummy.com/software/BeautifulSoup/bs4/doc/) - [Pandas](https://pandas.pydata.org/) **Testing:** - [Vitest](https://vitest.dev/) **Design & Planning:** - [Excalidraw](https://excalidraw.com/) - [Figma](https://www.figma.com/) ## Contributing Contributions are highly appreciated! Here's how you can get involved: ### Reporting Bugs & Suggesting Enhancements If you encounter an issue or have a suggestion for improvement, please create a [GitHub issue](https://github.com/andy-viera/contractorsUy/issues). ### Fixing Issues 1. Find an open issue in the [Issues tab](https://github.com/andy-viera/contractorsUy/issues). 2. Fork the repository and create a feature branch. 3. Submit a pull request with a clear description of your changes. ### Setting Up Locally #### Prerequisites - [pnpm](https://pnpm.io/) ```sh npm install -g pnpm ``` #### Installation 1. Clone the repository: ```sh git clone https://github.com/andy-viera/contractorsUy.git ``` 2. Navigate to the project folder: ```sh cd contractorsUy ``` 3. Install dependencies: ```sh pnpm install ``` 4. Start the development server: ```sh pnpm run dev ``` ## Get in Touch Andrés Viera - [email protected]