pro2s / doika

Модуль прыема ахвяраванняў для некамерцыйных арганізацый метадам эквайрынга.

Doika - модуль, які дапамагае прымаць ахвяраванні з дапамогай банкаўскіх картак і наладзіць новы падыход у фандрэйзінгу беларускіх некамерцыйных грамадскіх арганізацый на сваіх сайтах

Бягучыя задачы праекта

1. Рэфактарынг кода iтэрацыi 1.2 для пераносу на бягучую (1.3) iтэрацыю. Перанос фронтэнда на vue.js
2. Дэталізуем (абмяркоўваем) задачы па накірунках
3. Вывучаем API BePaid рэкурэнтные плацяжы

Як пачаць распрацоўку?

1. Праглядзець статус і роадмэп распрацоукi праекта на старонцы milestones.
2. Як разгарнуць лакальны асяродак для распрацоўкі [інструкцыя] (TODO).
3. Праглядзець дакументацыю.

• Архiтэктура файлаў i базы
• Блок-схемы
• Спiс класаў
• Вiкi Частка "для распрацоўшчыкаў".
• Пры з'яўленні пытанняў і цяжкасцей запытаць у Slack бягучых удзельнікаў каманды: @fr0zen, @tyuba4, @Сёмка, @SvetaN (інвайт у канал Slack магчыма атрымаць звярнуўшыся да нас праз форму).
• Увага! Робім пул рэквэсты ў галіну dev.

Як зрабіць свой унёсак

Патрабаванні да распрацоўкі

• Apache (rewrite mod on, for virtual host directory too: AllowOverride All )
• MySQL >= 5.5 PostgreSQL, SQLite, MSSQL Server Поўны спіс
• PHP >= 7.1.3
• OpenSSL PHP Extension, PDO PHP Extension, Mbstring PHP Extension, Tokenizer PHP Extension, XML PHP Extension, Ctype PHP Extension, JSON PHP Extension (PHP Extensions), BCMath PHP Extension, Sqlite3
• На базе фрэймворка Laravel 5.6 (для усталёўкі патрэбны Composer)
• Кодынг-стандарт
• Composer
• Node версія >= 8.10
• Прыклад афармлення бага
• Увага! Працуем з рэквэстамі (Pull request) на гітхабе у галіну dev (!)

Распрацоўшчыку. Устаноўка

linux

1. Заходзім у рэпазіторый https://github.com/diglabby/doika.git і ствараем для сябе fork
2. Дадаем змесціва fork рэпазіторыя ў корань вашага сайта з дапамогай git clone. Пераключаемся на dev branch, з дапамогай git checkout (напрыклад, git checkout dev)
3. Неабходна вызначыць групу і карыстальніка для ўсіх файлаў модуля камандай: sudo chown -R www-data:www-data .
4. З тэрмінала запусціць каманду composer install. Вы павінны запусціць з карнявой дырэкторыі doika
5. З тэрмінала запусціць каманду npm install. Вы павінны запусціць з карнявой дырэкторыі doika
6. Выконваем зборку фронтэнда npm run build
7. Рыхтуем канфіг файл. Для гэтага ў тэчцы doika ствараем копію файла .env.example і надаем яму імя .env (падказка: выканаць каманду cp .env.example .env)
8. Рыхтуем пустую Mysql базу.
9. Дадаем у файл .env свае дадзеныя, для падключэння к базе, створанай на папярэднім кроку DB_DATABASE={назва_базы} DB_USERNAME={лагін_для_падключэння} DB_PASSWORD={пароль}
10. Разгортваем базу дадзеных камандай php artisan migrate.
11. Пасля дадаем зыходныя дадзеныя камандай php artisan db:seed
12. Генерым ключ для laravel: зайсцi у папку doika праз i выканаць php artisan key:generate
13. Усталяваная версія павінна запускацца на Вашым лакальным хасце са шляхам http://[host-name]/doika/be/admin/login
14. Выкарыстоўваеце дадзеныя для ўвахода Лагін: [email protected] , Пароль: demo

win (Open Server)

1. Адкрыць налады Open Server(min PREMIUM edition), укладка дамены, ручное кіраванне, напісаць імя дамена, на прыклад doika, папка дамена выбраць localhost
2. Адкрыць укладку сервер, налады выкарыстання зменнай Path выбраць Свой Path + Win Path, паставіць каўку ў чэк-боксе запускаць сервер ў агрэсіўным рэжыме
3. Адкрыць ўкладку модулі, выбраць Apache 7.2, PHP 7.2, MySQL 5.7, захоўваем, запускаем сервер
4. Заходзім у рэпазіторый https://github.com/diglabby/doika.git і ствараем для сябе fork. Націскаем clone or download і капіруем адрас
5. Запускаем кансоль git из Open Server (мае закладкі - Git-CMD). З кансолі заходзім у тэчку localhost (напрыклад, cd d:\OSPanel\domains\localhost {шлях да тэчцы localhost}) і клоніруем туды праект пры дапамозе git clone (git clone https://github.com/diglabby/doika.git)
6. Заходзім з кансолі ў тэчку doika (каманда cd doika) і пры дапамозе гіт пераключаемся на dev branch (git checkout dev)
7. З тэрмінала запусціць каманду composer install. Вы павінны запусціць з карнявой дырэкторыі doika
8. З тэрмінала запусціць каманду npm install. Вы павінны запусціць з карнявой дырэкторыі doika
9. Выконваем зборку фронтэнда npm run build. Вы павінны запусціць з карнявой дырэкторыі doika
10. Рыхтуем пустую Mysql базу. Адкрываем PhpMyAdmin (127.0.0.1/openserver/phpmyadmin/index.php), ствараем новую БД.
11. Рыхтуем канфіг файл. Для гэтага ў тэчцы doika ствараем копію файла .env.example і надаем яму імя .env
12. Дадаем у файл .env свае дадзеныя, для падключэння к базе, створанай на папярэднім кроку DB_DATABASE={назва_базы} DB_USERNAME=root (калі не мянялі) DB_PASSWORD= (пуста калі не устонаўлівалі пароль)
13. Разгортваем базу дадзеных камандай php artisan migrate. Вы павінны запусціць з карнявой дырэкторыі doika
14. Пасля дадаем зыходныя дадзеныя камандай php artisan db:seed. Вы павінны запусціць з карнявой дырэкторыі doika
15. Генерым ключ для laravel камандай php artisan key:generate. Вы павінны запусціць з карнявой дырэкторыі doika
16. Усталяваная версія павінна запускацца на Вашым лакальным хасце са шляхам http://[host-name]/doika/be/admin/login
17. Выкарыстоўваеце дадзеныя для ўвахода Лагін: [email protected] , Пароль: demo

Структура праекта (распрацоўваем)

для чаго патрэбны ключавыя файлы (канфіг файл, файл інсталятар, дзе ляжыць фронт, дзе бэк, якія заўвагі па шляхах

Што трэба каб паставіць модуль?

• З арганізацыйнага боку: Арганізацыя павінна мець афіцыйную дзяржаўную рэгістрацыю, некамерцыйны статус (арт. 553 Грамадзянскага кодэкса РБ: ахвяраванні могуць прымаць толькі некамерцыйныя арганізацыі ) і рахунак у любым беларускім банку. Збор сродкаў ад фізічных асобаў можа ажыцяўляцца на любую мэту, якая не супярэчыць статутнай мэце некамерцыйнай арганізацыі.
• З юрыдычнага боку: Дамен грамадскай арганізацыі павінен быць абавязкова зарэгістраваны на юрыдычную асобу і прайсці рэгістрацыю ў БЕЛДІЭ – дзяржаўнай інспекцыі Рэспублікі Беларусь па электрасувязі Міністэрства сувязі і інфарматызацыі Рэспублікі Беларусь. Галоўная ўмова рэгістрацыі: размяшчэнне сайта на хостынгу на тэрыторыі Беларусі.
• З тэхнічнага боку: Для забеспячення бяспекі плацежных дадзенных на Вашай старонцы з модулем мы рэкамендуем выкарыстоўваць пратакол https. Сэрверны асяродак: apache, php, mysql.

Як паставіць модуль?

Апошняя версія і падрабязная інструкцыя па ўсталёўцы Doika_1.2 знаходзіцца тут.

Ліцэнзіі і абмежаванні

Выкарыстоўваем наступныя ліцэнзіі:

• GNU GPL 3.0 - для напісанага ў праекце кода
• Creative Commons Attribution Share-Alike - для ўсяго кантэнта у тым ліку выяваў, тэхнічнай дакументацыі

Прадукт распаўсюджваецца "як ёсць". Гэта значыць, любыя мадыфікацыі вы робіце самастойна або дамаўляецеся з камандай распрацоўшчыкаў на пэўны кошт ([email protected]).

Карысныя спасылкі

• Прэзентацыйная ўэб-старонка
• Прэзентацыя у паўэрпоінт

У мяне засталіся пытанні...

Заходзьце на старонку з найбольш частымі пытаннямі па праэкту Doika FAQ