From 67124711767d64f065eddaab64d5c7abf7ddc655 Mon Sep 17 00:00:00 2001 From: ErickSkrauch Date: Wed, 20 May 2020 02:36:32 +0300 Subject: [PATCH] Translate readme, add license and some composer.json fields --- LICENSE | 201 ++++++++++++++++++++++++++++++++++++++++++++++++++ README.md | 73 +++++++++--------- composer.json | 9 +++ composer.lock | 130 ++------------------------------ 4 files changed, 250 insertions(+), 163 deletions(-) create mode 100644 LICENSE diff --git a/LICENSE b/LICENSE new file mode 100644 index 0000000..4b46524 --- /dev/null +++ b/LICENSE @@ -0,0 +1,201 @@ + Apache License + Version 2.0, January 2004 + http://www.apache.org/licenses/ + + TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION + + 1. Definitions. + + "License" shall mean the terms and conditions for use, reproduction, + and distribution as defined by Sections 1 through 9 of this document. + + "Licensor" shall mean the copyright owner or entity authorized by + the copyright owner that is granting the License. + + "Legal Entity" shall mean the union of the acting entity and all + other entities that control, are controlled by, or are under common + control with that entity. For the purposes of this definition, + "control" means (i) the power, direct or indirect, to cause the + direction or management of such entity, whether by contract or + otherwise, or (ii) ownership of fifty percent (50%) or more of the + outstanding shares, or (iii) beneficial ownership of such entity. + + "You" (or "Your") shall mean an individual or Legal Entity + exercising permissions granted by this License. + + "Source" form shall mean the preferred form for making modifications, + including but not limited to software source code, documentation + source, and configuration files. + + "Object" form shall mean any form resulting from mechanical + transformation or translation of a Source form, including but + not limited to compiled object code, generated documentation, + and conversions to other media types. + + "Work" shall mean the work of authorship, whether in Source or + Object form, made available under the License, as indicated by a + copyright notice that is included in or attached to the work + (an example is provided in the Appendix below). + + "Derivative Works" shall mean any work, whether in Source or Object + form, that is based on (or derived from) the Work and for which the + editorial revisions, annotations, elaborations, or other modifications + represent, as a whole, an original work of authorship. For the purposes + of this License, Derivative Works shall not include works that remain + separable from, or merely link (or bind by name) to the interfaces of, + the Work and Derivative Works thereof. + + "Contribution" shall mean any work of authorship, including + the original version of the Work and any modifications or additions + to that Work or Derivative Works thereof, that is intentionally + submitted to Licensor for inclusion in the Work by the copyright owner + or by an individual or Legal Entity authorized to submit on behalf of + the copyright owner. For the purposes of this definition, "submitted" + means any form of electronic, verbal, or written communication sent + to the Licensor or its representatives, including but not limited to + communication on electronic mailing lists, source code control systems, + and issue tracking systems that are managed by, or on behalf of, the + Licensor for the purpose of discussing and improving the Work, but + excluding communication that is conspicuously marked or otherwise + designated in writing by the copyright owner as "Not a Contribution." + + "Contributor" shall mean Licensor and any individual or Legal Entity + on behalf of whom a Contribution has been received by Licensor and + subsequently incorporated within the Work. + + 2. Grant of Copyright License. Subject to the terms and conditions of + this License, each Contributor hereby grants to You a perpetual, + worldwide, non-exclusive, no-charge, royalty-free, irrevocable + copyright license to reproduce, prepare Derivative Works of, + publicly display, publicly perform, sublicense, and distribute the + Work and such Derivative Works in Source or Object form. + + 3. Grant of Patent License. Subject to the terms and conditions of + this License, each Contributor hereby grants to You a perpetual, + worldwide, non-exclusive, no-charge, royalty-free, irrevocable + (except as stated in this section) patent license to make, have made, + use, offer to sell, sell, import, and otherwise transfer the Work, + where such license applies only to those patent claims licensable + by such Contributor that are necessarily infringed by their + Contribution(s) alone or by combination of their Contribution(s) + with the Work to which such Contribution(s) was submitted. If You + institute patent litigation against any entity (including a + cross-claim or counterclaim in a lawsuit) alleging that the Work + or a Contribution incorporated within the Work constitutes direct + or contributory patent infringement, then any patent licenses + granted to You under this License for that Work shall terminate + as of the date such litigation is filed. + + 4. Redistribution. You may reproduce and distribute copies of the + Work or Derivative Works thereof in any medium, with or without + modifications, and in Source or Object form, provided that You + meet the following conditions: + + (a) You must give any other recipients of the Work or + Derivative Works a copy of this License; and + + (b) You must cause any modified files to carry prominent notices + stating that You changed the files; and + + (c) You must retain, in the Source form of any Derivative Works + that You distribute, all copyright, patent, trademark, and + attribution notices from the Source form of the Work, + excluding those notices that do not pertain to any part of + the Derivative Works; and + + (d) If the Work includes a "NOTICE" text file as part of its + distribution, then any Derivative Works that You distribute must + include a readable copy of the attribution notices contained + within such NOTICE file, excluding those notices that do not + pertain to any part of the Derivative Works, in at least one + of the following places: within a NOTICE text file distributed + as part of the Derivative Works; within the Source form or + documentation, if provided along with the Derivative Works; or, + within a display generated by the Derivative Works, if and + wherever such third-party notices normally appear. The contents + of the NOTICE file are for informational purposes only and + do not modify the License. You may add Your own attribution + notices within Derivative Works that You distribute, alongside + or as an addendum to the NOTICE text from the Work, provided + that such additional attribution notices cannot be construed + as modifying the License. + + You may add Your own copyright statement to Your modifications and + may provide additional or different license terms and conditions + for use, reproduction, or distribution of Your modifications, or + for any such Derivative Works as a whole, provided Your use, + reproduction, and distribution of the Work otherwise complies with + the conditions stated in this License. + + 5. Submission of Contributions. Unless You explicitly state otherwise, + any Contribution intentionally submitted for inclusion in the Work + by You to the Licensor shall be under the terms and conditions of + this License, without any additional terms or conditions. + Notwithstanding the above, nothing herein shall supersede or modify + the terms of any separate license agreement you may have executed + with Licensor regarding such Contributions. + + 6. Trademarks. This License does not grant permission to use the trade + names, trademarks, service marks, or product names of the Licensor, + except as required for reasonable and customary use in describing the + origin of the Work and reproducing the content of the NOTICE file. + + 7. Disclaimer of Warranty. Unless required by applicable law or + agreed to in writing, Licensor provides the Work (and each + Contributor provides its Contributions) on an "AS IS" BASIS, + WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or + implied, including, without limitation, any warranties or conditions + of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A + PARTICULAR PURPOSE. You are solely responsible for determining the + appropriateness of using or redistributing the Work and assume any + risks associated with Your exercise of permissions under this License. + + 8. Limitation of Liability. In no event and under no legal theory, + whether in tort (including negligence), contract, or otherwise, + unless required by applicable law (such as deliberate and grossly + negligent acts) or agreed to in writing, shall any Contributor be + liable to You for damages, including any direct, indirect, special, + incidental, or consequential damages of any character arising as a + result of this License or out of the use or inability to use the + Work (including but not limited to damages for loss of goodwill, + work stoppage, computer failure or malfunction, or any and all + other commercial damages or losses), even if such Contributor + has been advised of the possibility of such damages. + + 9. Accepting Warranty or Additional Liability. While redistributing + the Work or Derivative Works thereof, You may choose to offer, + and charge a fee for, acceptance of support, warranty, indemnity, + or other liability obligations and/or rights consistent with this + License. However, in accepting such obligations, You may act only + on Your own behalf and on Your sole responsibility, not on behalf + of any other Contributor, and only if You agree to indemnify, + defend, and hold each Contributor harmless for any liability + incurred by, or claims asserted against, such Contributor by reason + of your accepting any such warranty or additional liability. + + END OF TERMS AND CONDITIONS + + APPENDIX: How to apply the Apache License to your work. + + To apply the Apache License to your work, attach the following + boilerplate notice, with the fields enclosed by brackets "[]" + replaced with your own identifying information. (Don't include + the brackets!) The text should be enclosed in the appropriate + comment syntax for the file format. We also recommend that a + file or class name and description of purpose be included on the + same "printed page" as the copyright notice for easier + identification within third-party archives. + + Copyright 2020 Ely.by (http://ely.by) + + Licensed under the Apache License, Version 2.0 (the "License"); + you may not use this file except in compliance with the License. + You may obtain a copy of the License at + + http://www.apache.org/licenses/LICENSE-2.0 + + Unless required by applicable law or agreed to in writing, software + distributed under the License is distributed on an "AS IS" BASIS, + WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. + See the License for the specific language governing permissions and + limitations under the License. diff --git a/README.md b/README.md index eabeca7..35fee95 100644 --- a/README.md +++ b/README.md @@ -1,62 +1,55 @@ # Accounts Ely.by -Сервис управления Аккаунтами Ely.by, предоставляющий единую точку входа для наших и внешних сервисов по протоколу -OAuth2, а также реализующий сервер авторизации для серверов Minecraft и частично реализующий совместимое с API Mojang -для получения информации об аккаунтах. +Ely.by's accounts management service, which provides a single entry point for our own services, as well as for external +projects via the OAuth2 protocol. It also implements authorization server for Minecraft game servers and partially +implements Mojang-compatible API for obtaining accounts' information. -**Предупреждение**: этот проект не предназначен для использования вне экосистемы сервисов Ely.by. +**Warning**: this project isn't intended for use outside of the ecosystem of Ely.by's services. -## Разработка +## Development -Проект ориентирован на работу в Docker окружении, так что для полноценной работы проекта запускать его следует именно в -окружении Docker-контейнера. Ссылки на установки: +The project is designed to work in the Docker environment. Installation links: - [Docker](https://docs.docker.com/install/) - [docker-compose](https://docs.docker.com/compose/install/) -Далее необходимо создать форк репозитория, а после клонировать его: - -```sh -git clone git@github.com:/accounts.git -cd accounts -``` - -Затем необходимо создать локальные файлы `.env` и `docker-compose.yml`: +First you need to [fork](https://help.github.com/en/github/getting-started-with-github/fork-a-repo) the repository and +[clone](https://help.github.com/en/github/creating-cloning-and-archiving-repositories/cloning-a-repository) it. +After that you need to create local `.env` and `docker-compose.yml` files: ```sh cp .env.dist .env cp docker-compose.dist.yml docker-compose.yml ``` -Скопированные файлы можно изменить под условия локальной среды разработки, но в общем случае они пригодны для -использования без вашего вмешательства. +The copied files can be adjusted for your local environment, but generally they are ready to use without any +intervention. -Контейнеры не умеют автоматически устанавливать зависимости, так что их нужно установить самостоятельно. Если у вас в -системе установлен `php` и `composer`, то можно установить зависимости через команду `composer install`. Вы также всегда -можете установить зависимости с помощью контейнера: +Containers will not install dependencies automatically, so you have to install them manually. If you have `php` and +`composer` installed on your system, you can install dependencies with the `composer install` command. You can always +install dependencies using the container: ```sh docker-compose run --rm --no-deps app composer install ``` -При первом запуске произойдёт процесс загрузки и построения необходимых образов, после чего все контейнеры начнут -свою работу, и вы сможете приступить к разработке. +At the first start, all base images will be loaded and built (it can take a long time for the application's image), +after which you will be able to begin the development. -Для запуска всех контейнеров, используйте следующую команду: +To start all containers, use the following command: ```sh docker-compose up -d ``` -По умолчанию, в `docker-compose.yml` указан `80` порт для самого сервиса, а также `8080` порт для подключения -к phpMyAdmin. Если сервисы `web` и `phpmyadmin` выбросят ошибку, связанную с занятостью портов, то необходимо или -освободить необходимые порты (`80` и `8080`), или же изменить их, после чего заново выполнить команду -`docker-compose up -d`. +By default, `docker-compose.yml` specifies `80` port for the `web` service and `8080` port for `phpMyAdmin`. If these +services emits ports-related errors, it is necessary to make the required ports available or change them, and then run +the `docker-compose up -d` command again. -### Пользовательский интерфейс +### User interface -Этот репозиторий содержит в себе только код для API бекенда, в то время как интерфейс находится в -[соседнем репозитории](https://github.com/elyby/accounts-frontend). Пользователи Linux и Mac могут использовать -следующий скрипт, чтобы получить последнюю версию пользовательского интерфейса: +This repository contains only the source code for the backend API while the interface is in a +[nearby repository](https://github.com/elyby/accounts-frontend). Linux and Mac users can use the following script +to get the latest version of the UI: ```bash curl -s https://api.github.com/repos/elyby/accounts-frontend/releases/latest \ @@ -70,16 +63,20 @@ curl -s https://api.github.com/repos/elyby/accounts-frontend/releases/latest \ && rm -f /tmp/accounts-frontend.tar.gz ``` -Если этот скрипт не сработал для вас, то вы можете самостоятельно перейти на -[страницу релизов](https://github.com/elyby/accounts-frontend/releases), скачать подходящий `build`-архив и -разархивировать всё его содержимое в папку `frontend`. +If this script didn't work for you, you can manually go to the +[releases page](https://github.com/elyby/accounts-frontend/releases), download the suitable `build`-archive and extract +all its contents into the `frontend` folder. -### Как войти в работающий контейнер +### How to enter into a working container -Начиная с версии `docker-compose` 1.9.0, была добавлена команда `docker-compose exec`, которая позволяет выполнить -на работающем контейнере произвольную команду, основываясь на имени сервиса в compose-файле. Так, например, чтобы -войти в shell контейнера `app`, используйте следующую команду: +Using the [`docker-compose exec`](https://docs.docker.com/compose/reference/exec/) command you can easily execute any +desired command in running container by using its service's name from the `docker-compose.yml` file. For example, +to enter the shell of the `app` container, use the following command: ``` docker-compose exec app bash ``` + +# License + +This library is released under the [Apache 2.0](LICENSE). diff --git a/composer.json b/composer.json index ec831f1..d414ed8 100644 --- a/composer.json +++ b/composer.json @@ -3,6 +3,13 @@ "description": "Authentication service for the Ely.by", "homepage": "https://account.ely.by", "type": "project", + "license": "Apache-2.0", + "authors": [ + { + "name": "ErickSkrauch", + "email": "erickskrauch@ely.by" + } + ], "minimum-stability": "stable", "config": { "sort-packages": true @@ -50,6 +57,8 @@ "replace": { "paragonie/random_compat": "2.99.99", "symfony/polyfill-ctype": "*", + "symfony/polyfill-iconv": "*", + "symfony/polyfill-intl-idn": "*", "symfony/polyfill-mbstring": "*", "symfony/polyfill-php70": "*", "symfony/polyfill-php72": "*", diff --git a/composer.lock b/composer.lock index 9343bed..61c4b1e 100644 --- a/composer.lock +++ b/composer.lock @@ -4,7 +4,7 @@ "Read more about it at https://getcomposer.org/doc/01-basic-usage.md#installing-dependencies", "This file is @generated automatically" ], - "content-hash": "a47c02373de5268b03bda3a321e528c7", + "content-hash": "0a7da6289b610dac7bf1f92a778c2f25", "packages": [ { "name": "bacon/bacon-qr-code", @@ -119,7 +119,7 @@ "version": "3.3.11", "source": { "type": "git", - "url": "https://github.com/RobinHerbots/Inputmask.git", + "url": "git@github.com:RobinHerbots/Inputmask.git", "reference": "5e670ad62f50c738388d4dcec78d2888505ad77b" }, "dist": { @@ -188,7 +188,7 @@ "version": "2.0.7.1", "source": { "type": "git", - "url": "git@github.com:yiisoft/jquery-pjax.git", + "url": "https://github.com/yiisoft/jquery-pjax.git", "reference": "aef7b953107264f00234902a3880eb50dafc48be" }, "dist": { @@ -2081,127 +2081,6 @@ "homepage": "https://symfony.com", "time": "2019-11-17T21:56:56+00:00" }, - { - "name": "symfony/polyfill-iconv", - "version": "v1.13.1", - "source": { - "type": "git", - "url": "https://github.com/symfony/polyfill-iconv.git", - "reference": "a019efccc03f1a335af6b4f20c30f5ea8060be36" - }, - "dist": { - "type": "zip", - "url": "https://api.github.com/repos/symfony/polyfill-iconv/zipball/a019efccc03f1a335af6b4f20c30f5ea8060be36", - "reference": "a019efccc03f1a335af6b4f20c30f5ea8060be36", - "shasum": "" - }, - "require": { - "php": ">=5.3.3" - }, - "suggest": { - "ext-iconv": "For best performance" - }, - "type": "library", - "extra": { - "branch-alias": { - "dev-master": "1.13-dev" - } - }, - "autoload": { - "psr-4": { - "Symfony\\Polyfill\\Iconv\\": "" - }, - "files": [ - "bootstrap.php" - ] - }, - "notification-url": "https://packagist.org/downloads/", - "license": [ - "MIT" - ], - "authors": [ - { - "name": "Nicolas Grekas", - "email": "p@tchwork.com" - }, - { - "name": "Symfony Community", - "homepage": "https://symfony.com/contributors" - } - ], - "description": "Symfony polyfill for the Iconv extension", - "homepage": "https://symfony.com", - "keywords": [ - "compatibility", - "iconv", - "polyfill", - "portable", - "shim" - ], - "time": "2019-11-27T13:56:44+00:00" - }, - { - "name": "symfony/polyfill-intl-idn", - "version": "v1.13.1", - "source": { - "type": "git", - "url": "https://github.com/symfony/polyfill-intl-idn.git", - "reference": "6f9c239e61e1b0c9229a28ff89a812dc449c3d46" - }, - "dist": { - "type": "zip", - "url": "https://api.github.com/repos/symfony/polyfill-intl-idn/zipball/6f9c239e61e1b0c9229a28ff89a812dc449c3d46", - "reference": "6f9c239e61e1b0c9229a28ff89a812dc449c3d46", - "shasum": "" - }, - "require": { - "php": ">=5.3.3", - "symfony/polyfill-mbstring": "^1.3", - "symfony/polyfill-php72": "^1.9" - }, - "suggest": { - "ext-intl": "For best performance" - }, - "type": "library", - "extra": { - "branch-alias": { - "dev-master": "1.13-dev" - } - }, - "autoload": { - "psr-4": { - "Symfony\\Polyfill\\Intl\\Idn\\": "" - }, - "files": [ - "bootstrap.php" - ] - }, - "notification-url": "https://packagist.org/downloads/", - "license": [ - "MIT" - ], - "authors": [ - { - "name": "Laurent Bassin", - "email": "laurent@bassin.info" - }, - { - "name": "Symfony Community", - "homepage": "https://symfony.com/contributors" - } - ], - "description": "Symfony polyfill for intl's idn_to_ascii and idn_to_utf8 functions", - "homepage": "https://symfony.com", - "keywords": [ - "compatibility", - "idn", - "intl", - "polyfill", - "portable", - "shim" - ], - "time": "2019-11-27T13:56:44+00:00" - }, { "name": "symfony/process", "version": "v4.4.2", @@ -6367,5 +6246,6 @@ "ext-simplexml": "*", "ext-sodium": "*" }, - "platform-dev": [] + "platform-dev": [], + "plugin-api-version": "1.1.0" }