Giter Club home page Giter Club logo

zenplugins's Introduction

Zenmoney Plugins

Этот репозиторий содержит плагины, позволяющие ZenMoney получать данные о транзакциях из различных банков. Создать плагин может каждый, для этого важно знать окружение (API) и то, каким и в каком виде должен быть результат работы плагина.

Какие инструменты нужны для разработки

Понадобятся:

  • свежая версия Node.js (>= 8.10.0)

  • пакетный менеджер yarn (альтернатива npm) (мы знаем, что npm5.x уже работает не хуже yarn, так что мы обязательно на него переедем, чтобы пререквизитов стало меньше!)

  • IDE или просто текстовый редактор для JavaScript (мы используем WebStorm)

Пример, с которого стоит начать

Пример плагина, который можно скопировать и начать разработку

Вовсе необязательно идти рассматривать плагин на GitHub, можно запустить локально.

git clone [email protected]:zenmoney/ZenPlugins.git
cd ZenPlugins
yarn start example

Останется только открыть корень репозитория в IDE.

Анатомия плагина

Минимальные требования к плагину - это отдельная папка, в которой присутствуют файлы:

Что стоит еще почитать

Тестирование

Мы используем Jest (он клёвый).

Для запуска тестов всех плагинов нужно запустить:

yarn test

Запуск тестов, находящихся в папке src/plugins/example:

yarn test src/plugins/example

Мы призываем вас, помимо наличия модульных тестов на части плагина, написать хотя бы один интеграционный тест (тестирующий функцию scrape, мокая сеть минимально вариативными данными).

Интеграция

В master ветку изменения попадают через pull request с fork-а.

Любые изменения (создание плагина, фикс багов) проходят code review.

Публикация

Делается вручную Костей по факту мержа Pull Request с плагином в master ветку.

Развернуть новую версию можно и для конкретного пользователя (к примеру, для тестирования корректной работы небольшой группой бета-тестировщиков на мобильном устройстве, например, вами :) ).

Как только новая версия плагина опубликована, она автоматически обновляется и используется при следующей синхронизации мобильным приложением.

Текущую используемую на мобильном девайсе версию плагина можно увидеть в окошке настроек подключения.

zenplugins's People

Watchers

 avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    🖖 Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. 📊📈🎉

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google ❤️ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.