About The Project

There are many great Brazilian Tools templates available on GitHub, however, I didn't find one that really suit my needs so I created this enhanced one. I want to create a Brazilian Tool so amazing that it'll be the last one you ever need -- I think this is it.

Here's why:

• Your time should be focused on creating something amazing. A project that solves a problem and helps others
• You shouldn't be doing the same tasks over and over like creating a invoice from scratch
• You should element DRY principles to the rest of your life :smile:

Of course, no one template will serve all projects since your needs may be different. So I'll be adding more in the near future. You may also suggest changes by forking this repo and creating a pull request or opening an issue. Thanks to all the people have have contributed to expanding this!

Built With

• JavaScript
• TypeScript
• ESlint

Getting Started

This is an example of how you may give instructions on setting up your project locally. To get a local copy up and running follow these simple example steps.

Prerequisites

This is an example of how to list things you need to use the software and how to install them.

Installation in usage project

• yarn

  yarn add brazilianutils

• npm

  npm install brazilianutils

Installation of package to local test

1. Clone the repo

   git clone https://github.com/giovannifersan/brazilianutils.git

2. Installing packages

   yarn || npm install

3. Run the tests

   yarn test || npm run test

Roadmap

See the open issues for a list of proposed features (and known issues).

Contributing

Contributions are what make the open source community such an amazing place to be learn, inspire, and create. Any contributions you make are greatly appreciated.

1. Fork the Project
2. Create your Feature Branch (git checkout -b feature/AmazingFeature)
3. Commit your Changes (git commit -m 'Add some AmazingFeature')
4. Push to the Branch (git push origin feature/AmazingFeature)
5. Open a Pull Request

License

Distributed under the MIT License. See LICENSE for more information.

Contact

Giovanni Fersan - @giovannifersan - Twitter

Project Link: https://github.com/giovannifersan/brazilianutils