Iiifoooddie

Um prototipo de sdk para a api do ifood escrito em typescript e de código aberto e de comunidade sinta se livra para usar, melhorar, testar, documentar, codar 🥳🥳🥳.

• Não é apenas mais um modulo npm entre os milhões que são criados todos os dias, como todos já estamos acostumados alguns pouco uteis outros nem tanto assim... mas espero que esse projeto fique na terceira categoria dos realmentes uteis.

• Se você precisa integrar com ifood esse projeto pode ser um otimo bootrasp para você ;).

• Toda contribuição é bem vinda 😁😁😁

Getting Started

Prerequisites

What things you need to install and run:

• nodejs
• das it

# make sure you can run in the console
node --version
npm --version

Installing

Clone the repo to your computer.

Run in the terminal:

npm install
node index.js

Running the tests

To run the tests, use npm test, that will run all the tests. There is also test:unit test:functional test:integration.

Coding Style in Tests

See the Jest project.

Deployment

You can run it right from your console with either: npm start or node index.js

There are GitHub workflows that run actions in .github/workflows that will automate the testing, coverage reports, documentation, versioning and publishing of the package to both GitHub Packages and the NPM Repository. Testing is completed by GitHub Actions with Jest on all systems (Windows, macOS and Linux) as well as the latest 3 versions of Node (11, 12, 14) and the coverage reports are sent to Codecov if you have the app connected to your GitHub account. Documents can be found at the GitHub repo project website (generated from the readme) and appending /docs onto the URL. Packages can be found at both the NPM Repo and GitHub repo.

Built With

• NodeJS
• RollupJS
• Jest
• TypeScript
• Axios
• Winston
• Dotenv

Contributing

Please read CONTRIBUTING.md for details on our code of conduct, and the process for submitting pull requests to us.

Versioning

We use SemVer for versioning. For the versions available, see the tags on this repository.

Authors

• Allan Contesini - your profile

See also the list of contributors who participated in this project.

License

This project is licensed under the MIT License - see the LICENSE.md file for details

Acknowledgments

• Ifood
• Spencer Pollock - Provided typescript bootstrap - Typescript-bootstrap

Created by Allan Contesini. Contact me <spencer at [email protected]>