From de82bca61d36972535f7988366a51f3bb3ca9b18 Mon Sep 17 00:00:00 2001 From: Michel Roux Date: Thu, 26 Dec 2024 21:15:05 +0100 Subject: [PATCH] feat: :tada: add template --- .dockerignore | 14 + .eslintrc.cjs | 14 + .gitea/workflows/app_template.yml | 87 ++++ .gitignore | 14 + .l10nignore | 14 + .nvmrc | 1 + .php-cs-fixer.dist.php | 31 ++ CHANGELOG.md | 12 + CODE_OF_CONDUCT.md | 9 + Dockerfile | 22 + LICENSE | 661 ++++++++++++++++++++++++++++++ Makefile | 145 +++++++ README.md | 25 ++ appinfo/info.xml | 27 ++ composer.json | 42 ++ img/app-dark.svg | 1 + img/app.svg | 1 + lib/AppInfo/Application.php | 23 ++ lib/Controller/ApiController.php | 29 ++ lib/Controller/PageController.php | 27 ++ package.json | 41 ++ psalm.xml | 21 + rector.php | 34 ++ renovate.json | 4 + src/App.vue | 26 ++ src/main.ts | 6 + stylelint.config.cjs | 3 + templates/index.php | 1 + tsconfig.json | 15 + vite.config.ts | 20 + 30 files changed, 1370 insertions(+) create mode 100644 .dockerignore create mode 100644 .eslintrc.cjs create mode 100644 .gitea/workflows/app_template.yml create mode 100644 .gitignore create mode 100644 .l10nignore create mode 100644 .nvmrc create mode 100644 .php-cs-fixer.dist.php create mode 100644 CHANGELOG.md create mode 100644 CODE_OF_CONDUCT.md create mode 100644 Dockerfile create mode 100644 LICENSE create mode 100644 Makefile create mode 100644 README.md create mode 100644 appinfo/info.xml create mode 100644 composer.json create mode 100644 img/app-dark.svg create mode 100644 img/app.svg create mode 100644 lib/AppInfo/Application.php create mode 100644 lib/Controller/ApiController.php create mode 100644 lib/Controller/PageController.php create mode 100644 package.json create mode 100644 psalm.xml create mode 100644 rector.php create mode 100644 renovate.json create mode 100644 src/App.vue create mode 100644 src/main.ts create mode 100644 stylelint.config.cjs create mode 100644 templates/index.php create mode 100644 tsconfig.json create mode 100644 vite.config.ts diff --git a/.dockerignore b/.dockerignore new file mode 100644 index 0000000..1cc0bce --- /dev/null +++ b/.dockerignore @@ -0,0 +1,14 @@ +/.idea/ +/*.iml + +/vendor/ +/vendor-bin/*/vendor/ + +/.php-cs-fixer.cache +/tests/.phpunit.cache + +/node_modules/ +/js/ +/css/ + +/build/ diff --git a/.eslintrc.cjs b/.eslintrc.cjs new file mode 100644 index 0000000..59d8f8c --- /dev/null +++ b/.eslintrc.cjs @@ -0,0 +1,14 @@ +module.exports = { + extends: [ + '@nextcloud', + '@vue/eslint-config-typescript/recommended', + 'plugin:prettier/recommended', + ], + parser: 'vue-eslint-parser', + rules: { + 'jsdoc/require-jsdoc': 'off', + 'vue/first-attribute-linebreak': 'off', + 'sort-imports': 'error', + 'vue/attributes-order': ['error', { alphabetical: true }], + }, +} diff --git a/.gitea/workflows/app_template.yml b/.gitea/workflows/app_template.yml new file mode 100644 index 0000000..ea008f5 --- /dev/null +++ b/.gitea/workflows/app_template.yml @@ -0,0 +1,87 @@ +name: retro +on: [push] + +jobs: + xml: + runs-on: ubuntu-latest + steps: + - uses: actions/checkout@v4 + - run: wget https://raw.githubusercontent.com/nextcloud/appstore/master/nextcloudappstore/api/v1/release/info.xsd + - uses: ChristophWurst/xmllint-action@v1 + with: + xml-file: ./appinfo/info.xml + xml-schema-file: ./info.xsd + + php: + runs-on: ubuntu-latest + container: nextcloud:30 + steps: + - run: apt-get update + - run: apt-get install -y git nodejs + - uses: actions/checkout@v4 + - run: curl -sSLo /usr/local/bin/composer https://getcomposer.org/download/latest-stable/composer.phar + - run: chmod +x /usr/local/bin/composer + - run: composer install + - run: composer run lint + - run: composer run cs:check + - run: composer run psalm + + nodejs: + runs-on: ubuntu-latest + steps: + - uses: actions/checkout@v4 + - uses: skjnldsv/read-package-engines-version-actions@v3 + id: versions + with: + fallbackNode: '^20' + fallbackNpm: '^10' + - uses: actions/setup-node@v4 + with: + node-version: ${{ steps.versions.outputs.nodeVersion }} + - run: npm i -g 'npm@${{ steps.versions.outputs.npmVersion }}' + - run: npm ci + - run: npm run lint + - run: npm run stylelint + - run: npm run build + + release: + if: gitea.ref_type == 'tag' + runs-on: ubuntu-latest + container: nextcloud:30 + steps: + - run: apt-get update + - run: apt-get install -y git nodejs + - uses: actions/checkout@v4 + - run: curl -sSLo /usr/local/bin/composer https://getcomposer.org/download/latest-stable/composer.phar + - run: chmod +x /usr/local/bin/composer + - uses: skjnldsv/read-package-engines-version-actions@v3 + id: versions + with: + fallbackNode: '^20' + fallbackNpm: '^10' + - uses: actions/setup-node@v4 + with: + node-version: ${{ steps.versions.outputs.nodeVersion }} + - run: npm i -g 'npm@${{ steps.versions.outputs.npmVersion }}' + - run: make dist + - uses: akkuman/gitea-release-action@v1 + with: + files: | + build/artifacts/${{ gitea.event.repository.name }}.tar.gz + - uses: FKLC/sign-files-action@v1.0.0 + with: + privateKey: ${{ secrets.PRIVATEKEY }} + algorithm: RSA-SHA512 + extension: .sig + outputFolder: build/artifacts + files: | + build/artifacts/${{ gitea.event.repository.name }}.tar.gz + - id: sign + run: echo "SIGNATURE=$(cat build/artifacts/${{ gitea.event.repository.name }}.tar.gz.sig | openssl base64 -A)" >> $GITHUB_OUTPUT + - uses: actionsflow/axios@v1 + with: + url: https://apps.nextcloud.com/api/v1/apps/releases + method: POST + accept: 200,201 + headers: '{ "Authorization": "Token <<<${{ secrets.TOKEN }}>>>" }' + data: '{ "download": "https://git.crystalyx.net/${{ gitea.repository }}/releases/download/<<<${{ gitea.ref_name }}>>>/${{ gitea.event.repository.name }}.tar.gz", "signature": "<<<${{ steps.sign.outputs.SIGNATURE }}>>>" }' diff --git a/.gitignore b/.gitignore new file mode 100644 index 0000000..1cc0bce --- /dev/null +++ b/.gitignore @@ -0,0 +1,14 @@ +/.idea/ +/*.iml + +/vendor/ +/vendor-bin/*/vendor/ + +/.php-cs-fixer.cache +/tests/.phpunit.cache + +/node_modules/ +/js/ +/css/ + +/build/ diff --git a/.l10nignore b/.l10nignore new file mode 100644 index 0000000..89e7f37 --- /dev/null +++ b/.l10nignore @@ -0,0 +1,14 @@ +.idea/ +*.iml + +vendor/ +vendor-bin/*/vendor/ + +.php-cs-fixer.cache +tests/.phpunit.cache + +node_modules/ +js/ +css/ + +build/ diff --git a/.nvmrc b/.nvmrc new file mode 100644 index 0000000..209e3ef --- /dev/null +++ b/.nvmrc @@ -0,0 +1 @@ +20 diff --git a/.php-cs-fixer.dist.php b/.php-cs-fixer.dist.php new file mode 100644 index 0000000..74670ab --- /dev/null +++ b/.php-cs-fixer.dist.php @@ -0,0 +1,31 @@ +getFinder() + ->notPath('build') + ->notPath('l10n') + ->notPath('node_modules') + ->notPath('src') + ->notPath('vendor') + ->in(__DIR__); + +return $config; diff --git a/CHANGELOG.md b/CHANGELOG.md new file mode 100644 index 0000000..ab830f7 --- /dev/null +++ b/CHANGELOG.md @@ -0,0 +1,12 @@ +# Changelog + +All notable changes to this project will be documented in this file. + +The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.1.0/), +and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html). + +## [Unreleased] + +### Added + +- First release diff --git a/CODE_OF_CONDUCT.md b/CODE_OF_CONDUCT.md new file mode 100644 index 0000000..d906007 --- /dev/null +++ b/CODE_OF_CONDUCT.md @@ -0,0 +1,9 @@ +In the Nextcloud community, participants from all over the world come together to create Free Software for a free internet. This is made possible by the support, hard work and enthusiasm of thousands of people, including those who create and use Nextcloud software. + +Our code of conduct offers some guidance to ensure Nextcloud participants can cooperate effectively in a positive and inspiring atmosphere, and to explain how together we can strengthen and support each other. + +The Code of Conduct is shared by all contributors and users who engage with the Nextcloud team and its community services. It presents a summary of the shared values and “common sense” thinking in our community. + +You can find our full code of conduct on our website: https://nextcloud.com/code-of-conduct/ + +Please, keep our CoC in mind when you contribute! That way, everyone can be a part of our community in a productive, positive, creative and fun way. diff --git a/Dockerfile b/Dockerfile new file mode 100644 index 0000000..1d4e326 --- /dev/null +++ b/Dockerfile @@ -0,0 +1,22 @@ +FROM nextcloud:30 + +ARG APP_NAME=retro +ENV NEXTCLOUD_UPDATE=1 +ENV NEXTCLOUD_ADMIN_USER=$APP_NAME +ENV NEXTCLOUD_ADMIN_PASSWORD=$APP_NAME +ENV NEXTCLOUD_INIT_HTACCESS=1 +ENV SQLITE_DATABASE=$APP_NAME + +RUN apt-get update && \ + apt-get install -y nodejs npm sqlite3 && \ + rm -f /usr/local/etc/php/conf.d/opcache-recommended.ini && \ + /entrypoint.sh true + +USER www-data + +COPY --chown=www-data:www-data . apps/$APP_NAME +RUN cd apps/$APP_NAME && make build && cd - && \ + php occ app:enable $APP_NAME && \ + php occ config:system:set debug --value=true + +USER root diff --git a/LICENSE b/LICENSE new file mode 100644 index 0000000..be3f7b2 --- /dev/null +++ b/LICENSE @@ -0,0 +1,661 @@ + GNU AFFERO GENERAL PUBLIC LICENSE + Version 3, 19 November 2007 + + Copyright (C) 2007 Free Software Foundation, Inc. + Everyone is permitted to copy and distribute verbatim copies + of this license document, but changing it is not allowed. + + Preamble + + The GNU Affero General Public License is a free, copyleft license for +software and other kinds of works, specifically designed to ensure +cooperation with the community in the case of network server software. + + The licenses for most software and other practical works are designed +to take away your freedom to share and change the works. By contrast, +our General Public Licenses are intended to guarantee your freedom to +share and change all versions of a program--to make sure it remains free +software for all its users. + + When we speak of free software, we are referring to freedom, not +price. Our General Public Licenses are designed to make sure that you +have the freedom to distribute copies of free software (and charge for +them if you wish), that you receive source code or can get it if you +want it, that you can change the software or use pieces of it in new +free programs, and that you know you can do these things. + + Developers that use our General Public Licenses protect your rights +with two steps: (1) assert copyright on the software, and (2) offer +you this License which gives you legal permission to copy, distribute +and/or modify the software. + + A secondary benefit of defending all users' freedom is that +improvements made in alternate versions of the program, if they +receive widespread use, become available for other developers to +incorporate. Many developers of free software are heartened and +encouraged by the resulting cooperation. However, in the case of +software used on network servers, this result may fail to come about. +The GNU General Public License permits making a modified version and +letting the public access it on a server without ever releasing its +source code to the public. + + The GNU Affero General Public License is designed specifically to +ensure that, in such cases, the modified source code becomes available +to the community. It requires the operator of a network server to +provide the source code of the modified version running there to the +users of that server. Therefore, public use of a modified version, on +a publicly accessible server, gives the public access to the source +code of the modified version. + + An older license, called the Affero General Public License and +published by Affero, was designed to accomplish similar goals. This is +a different license, not a version of the Affero GPL, but Affero has +released a new version of the Affero GPL which permits relicensing under +this license. + + The precise terms and conditions for copying, distribution and +modification follow. + + TERMS AND CONDITIONS + + 0. Definitions. + + "This License" refers to version 3 of the GNU Affero General Public License. + + "Copyright" also means copyright-like laws that apply to other kinds of +works, such as semiconductor masks. + + "The Program" refers to any copyrightable work licensed under this +License. Each licensee is addressed as "you". "Licensees" and +"recipients" may be individuals or organizations. + + To "modify" a work means to copy from or adapt all or part of the work +in a fashion requiring copyright permission, other than the making of an +exact copy. The resulting work is called a "modified version" of the +earlier work or a work "based on" the earlier work. + + A "covered work" means either the unmodified Program or a work based +on the Program. + + To "propagate" a work means to do anything with it that, without +permission, would make you directly or secondarily liable for +infringement under applicable copyright law, except executing it on a +computer or modifying a private copy. Propagation includes copying, +distribution (with or without modification), making available to the +public, and in some countries other activities as well. + + To "convey" a work means any kind of propagation that enables other +parties to make or receive copies. Mere interaction with a user through +a computer network, with no transfer of a copy, is not conveying. + + An interactive user interface displays "Appropriate Legal Notices" +to the extent that it includes a convenient and prominently visible +feature that (1) displays an appropriate copyright notice, and (2) +tells the user that there is no warranty for the work (except to the +extent that warranties are provided), that licensees may convey the +work under this License, and how to view a copy of this License. If +the interface presents a list of user commands or options, such as a +menu, a prominent item in the list meets this criterion. + + 1. Source Code. + + The "source code" for a work means the preferred form of the work +for making modifications to it. "Object code" means any non-source +form of a work. + + A "Standard Interface" means an interface that either is an official +standard defined by a recognized standards body, or, in the case of +interfaces specified for a particular programming language, one that +is widely used among developers working in that language. + + The "System Libraries" of an executable work include anything, other +than the work as a whole, that (a) is included in the normal form of +packaging a Major Component, but which is not part of that Major +Component, and (b) serves only to enable use of the work with that +Major Component, or to implement a Standard Interface for which an +implementation is available to the public in source code form. A +"Major Component", in this context, means a major essential component +(kernel, window system, and so on) of the specific operating system +(if any) on which the executable work runs, or a compiler used to +produce the work, or an object code interpreter used to run it. + + The "Corresponding Source" for a work in object code form means all +the source code needed to generate, install, and (for an executable +work) run the object code and to modify the work, including scripts to +control those activities. However, it does not include the work's +System Libraries, or general-purpose tools or generally available free +programs which are used unmodified in performing those activities but +which are not part of the work. For example, Corresponding Source +includes interface definition files associated with source files for +the work, and the source code for shared libraries and dynamically +linked subprograms that the work is specifically designed to require, +such as by intimate data communication or control flow between those +subprograms and other parts of the work. + + The Corresponding Source need not include anything that users +can regenerate automatically from other parts of the Corresponding +Source. + + The Corresponding Source for a work in source code form is that +same work. + + 2. Basic Permissions. + + All rights granted under this License are granted for the term of +copyright on the Program, and are irrevocable provided the stated +conditions are met. This License explicitly affirms your unlimited +permission to run the unmodified Program. The output from running a +covered work is covered by this License only if the output, given its +content, constitutes a covered work. This License acknowledges your +rights of fair use or other equivalent, as provided by copyright law. + + You may make, run and propagate covered works that you do not +convey, without conditions so long as your license otherwise remains +in force. You may convey covered works to others for the sole purpose +of having them make modifications exclusively for you, or provide you +with facilities for running those works, provided that you comply with +the terms of this License in conveying all material for which you do +not control copyright. Those thus making or running the covered works +for you must do so exclusively on your behalf, under your direction +and control, on terms that prohibit them from making any copies of +your copyrighted material outside their relationship with you. + + Conveying under any other circumstances is permitted solely under +the conditions stated below. Sublicensing is not allowed; section 10 +makes it unnecessary. + + 3. Protecting Users' Legal Rights From Anti-Circumvention Law. + + No covered work shall be deemed part of an effective technological +measure under any applicable law fulfilling obligations under article +11 of the WIPO copyright treaty adopted on 20 December 1996, or +similar laws prohibiting or restricting circumvention of such +measures. + + When you convey a covered work, you waive any legal power to forbid +circumvention of technological measures to the extent such circumvention +is effected by exercising rights under this License with respect to +the covered work, and you disclaim any intention to limit operation or +modification of the work as a means of enforcing, against the work's +users, your or third parties' legal rights to forbid circumvention of +technological measures. + + 4. Conveying Verbatim Copies. + + You may convey verbatim copies of the Program's source code as you +receive it, in any medium, provided that you conspicuously and +appropriately publish on each copy an appropriate copyright notice; +keep intact all notices stating that this License and any +non-permissive terms added in accord with section 7 apply to the code; +keep intact all notices of the absence of any warranty; and give all +recipients a copy of this License along with the Program. + + You may charge any price or no price for each copy that you convey, +and you may offer support or warranty protection for a fee. + + 5. Conveying Modified Source Versions. + + You may convey a work based on the Program, or the modifications to +produce it from the Program, in the form of source code under the +terms of section 4, provided that you also meet all of these conditions: + + a) The work must carry prominent notices stating that you modified + it, and giving a relevant date. + + b) The work must carry prominent notices stating that it is + released under this License and any conditions added under section + 7. This requirement modifies the requirement in section 4 to + "keep intact all notices". + + c) You must license the entire work, as a whole, under this + License to anyone who comes into possession of a copy. This + License will therefore apply, along with any applicable section 7 + additional terms, to the whole of the work, and all its parts, + regardless of how they are packaged. This License gives no + permission to license the work in any other way, but it does not + invalidate such permission if you have separately received it. + + d) If the work has interactive user interfaces, each must display + Appropriate Legal Notices; however, if the Program has interactive + interfaces that do not display Appropriate Legal Notices, your + work need not make them do so. + + A compilation of a covered work with other separate and independent +works, which are not by their nature extensions of the covered work, +and which are not combined with it such as to form a larger program, +in or on a volume of a storage or distribution medium, is called an +"aggregate" if the compilation and its resulting copyright are not +used to limit the access or legal rights of the compilation's users +beyond what the individual works permit. Inclusion of a covered work +in an aggregate does not cause this License to apply to the other +parts of the aggregate. + + 6. Conveying Non-Source Forms. + + You may convey a covered work in object code form under the terms +of sections 4 and 5, provided that you also convey the +machine-readable Corresponding Source under the terms of this License, +in one of these ways: + + a) Convey the object code in, or embodied in, a physical product + (including a physical distribution medium), accompanied by the + Corresponding Source fixed on a durable physical medium + customarily used for software interchange. + + b) Convey the object code in, or embodied in, a physical product + (including a physical distribution medium), accompanied by a + written offer, valid for at least three years and valid for as + long as you offer spare parts or customer support for that product + model, to give anyone who possesses the object code either (1) a + copy of the Corresponding Source for all the software in the + product that is covered by this License, on a durable physical + medium customarily used for software interchange, for a price no + more than your reasonable cost of physically performing this + conveying of source, or (2) access to copy the + Corresponding Source from a network server at no charge. + + c) Convey individual copies of the object code with a copy of the + written offer to provide the Corresponding Source. This + alternative is allowed only occasionally and noncommercially, and + only if you received the object code with such an offer, in accord + with subsection 6b. + + d) Convey the object code by offering access from a designated + place (gratis or for a charge), and offer equivalent access to the + Corresponding Source in the same way through the same place at no + further charge. You need not require recipients to copy the + Corresponding Source along with the object code. If the place to + copy the object code is a network server, the Corresponding Source + may be on a different server (operated by you or a third party) + that supports equivalent copying facilities, provided you maintain + clear directions next to the object code saying where to find the + Corresponding Source. Regardless of what server hosts the + Corresponding Source, you remain obligated to ensure that it is + available for as long as needed to satisfy these requirements. + + e) Convey the object code using peer-to-peer transmission, provided + you inform other peers where the object code and Corresponding + Source of the work are being offered to the general public at no + charge under subsection 6d. + + A separable portion of the object code, whose source code is excluded +from the Corresponding Source as a System Library, need not be +included in conveying the object code work. + + A "User Product" is either (1) a "consumer product", which means any +tangible personal property which is normally used for personal, family, +or household purposes, or (2) anything designed or sold for incorporation +into a dwelling. In determining whether a product is a consumer product, +doubtful cases shall be resolved in favor of coverage. For a particular +product received by a particular user, "normally used" refers to a +typical or common use of that class of product, regardless of the status +of the particular user or of the way in which the particular user +actually uses, or expects or is expected to use, the product. A product +is a consumer product regardless of whether the product has substantial +commercial, industrial or non-consumer uses, unless such uses represent +the only significant mode of use of the product. + + "Installation Information" for a User Product means any methods, +procedures, authorization keys, or other information required to install +and execute modified versions of a covered work in that User Product from +a modified version of its Corresponding Source. The information must +suffice to ensure that the continued functioning of the modified object +code is in no case prevented or interfered with solely because +modification has been made. + + If you convey an object code work under this section in, or with, or +specifically for use in, a User Product, and the conveying occurs as +part of a transaction in which the right of possession and use of the +User Product is transferred to the recipient in perpetuity or for a +fixed term (regardless of how the transaction is characterized), the +Corresponding Source conveyed under this section must be accompanied +by the Installation Information. But this requirement does not apply +if neither you nor any third party retains the ability to install +modified object code on the User Product (for example, the work has +been installed in ROM). + + The requirement to provide Installation Information does not include a +requirement to continue to provide support service, warranty, or updates +for a work that has been modified or installed by the recipient, or for +the User Product in which it has been modified or installed. Access to a +network may be denied when the modification itself materially and +adversely affects the operation of the network or violates the rules and +protocols for communication across the network. + + Corresponding Source conveyed, and Installation Information provided, +in accord with this section must be in a format that is publicly +documented (and with an implementation available to the public in +source code form), and must require no special password or key for +unpacking, reading or copying. + + 7. Additional Terms. + + "Additional permissions" are terms that supplement the terms of this +License by making exceptions from one or more of its conditions. +Additional permissions that are applicable to the entire Program shall +be treated as though they were included in this License, to the extent +that they are valid under applicable law. If additional permissions +apply only to part of the Program, that part may be used separately +under those permissions, but the entire Program remains governed by +this License without regard to the additional permissions. + + When you convey a copy of a covered work, you may at your option +remove any additional permissions from that copy, or from any part of +it. (Additional permissions may be written to require their own +removal in certain cases when you modify the work.) You may place +additional permissions on material, added by you to a covered work, +for which you have or can give appropriate copyright permission. + + Notwithstanding any other provision of this License, for material you +add to a covered work, you may (if authorized by the copyright holders of +that material) supplement the terms of this License with terms: + + a) Disclaiming warranty or limiting liability differently from the + terms of sections 15 and 16 of this License; or + + b) Requiring preservation of specified reasonable legal notices or + author attributions in that material or in the Appropriate Legal + Notices displayed by works containing it; or + + c) Prohibiting misrepresentation of the origin of that material, or + requiring that modified versions of such material be marked in + reasonable ways as different from the original version; or + + d) Limiting the use for publicity purposes of names of licensors or + authors of the material; or + + e) Declining to grant rights under trademark law for use of some + trade names, trademarks, or service marks; or + + f) Requiring indemnification of licensors and authors of that + material by anyone who conveys the material (or modified versions of + it) with contractual assumptions of liability to the recipient, for + any liability that these contractual assumptions directly impose on + those licensors and authors. + + All other non-permissive additional terms are considered "further +restrictions" within the meaning of section 10. If the Program as you +received it, or any part of it, contains a notice stating that it is +governed by this License along with a term that is a further +restriction, you may remove that term. If a license document contains +a further restriction but permits relicensing or conveying under this +License, you may add to a covered work material governed by the terms +of that license document, provided that the further restriction does +not survive such relicensing or conveying. + + If you add terms to a covered work in accord with this section, you +must place, in the relevant source files, a statement of the +additional terms that apply to those files, or a notice indicating +where to find the applicable terms. + + Additional terms, permissive or non-permissive, may be stated in the +form of a separately written license, or stated as exceptions; +the above requirements apply either way. + + 8. Termination. + + You may not propagate or modify a covered work except as expressly +provided under this License. Any attempt otherwise to propagate or +modify it is void, and will automatically terminate your rights under +this License (including any patent licenses granted under the third +paragraph of section 11). + + However, if you cease all violation of this License, then your +license from a particular copyright holder is reinstated (a) +provisionally, unless and until the copyright holder explicitly and +finally terminates your license, and (b) permanently, if the copyright +holder fails to notify you of the violation by some reasonable means +prior to 60 days after the cessation. + + Moreover, your license from a particular copyright holder is +reinstated permanently if the copyright holder notifies you of the +violation by some reasonable means, this is the first time you have +received notice of violation of this License (for any work) from that +copyright holder, and you cure the violation prior to 30 days after +your receipt of the notice. + + Termination of your rights under this section does not terminate the +licenses of parties who have received copies or rights from you under +this License. If your rights have been terminated and not permanently +reinstated, you do not qualify to receive new licenses for the same +material under section 10. + + 9. Acceptance Not Required for Having Copies. + + You are not required to accept this License in order to receive or +run a copy of the Program. Ancillary propagation of a covered work +occurring solely as a consequence of using peer-to-peer transmission +to receive a copy likewise does not require acceptance. However, +nothing other than this License grants you permission to propagate or +modify any covered work. These actions infringe copyright if you do +not accept this License. Therefore, by modifying or propagating a +covered work, you indicate your acceptance of this License to do so. + + 10. Automatic Licensing of Downstream Recipients. + + Each time you convey a covered work, the recipient automatically +receives a license from the original licensors, to run, modify and +propagate that work, subject to this License. You are not responsible +for enforcing compliance by third parties with this License. + + An "entity transaction" is a transaction transferring control of an +organization, or substantially all assets of one, or subdividing an +organization, or merging organizations. If propagation of a covered +work results from an entity transaction, each party to that +transaction who receives a copy of the work also receives whatever +licenses to the work the party's predecessor in interest had or could +give under the previous paragraph, plus a right to possession of the +Corresponding Source of the work from the predecessor in interest, if +the predecessor has it or can get it with reasonable efforts. + + You may not impose any further restrictions on the exercise of the +rights granted or affirmed under this License. For example, you may +not impose a license fee, royalty, or other charge for exercise of +rights granted under this License, and you may not initiate litigation +(including a cross-claim or counterclaim in a lawsuit) alleging that +any patent claim is infringed by making, using, selling, offering for +sale, or importing the Program or any portion of it. + + 11. Patents. + + A "contributor" is a copyright holder who authorizes use under this +License of the Program or a work on which the Program is based. The +work thus licensed is called the contributor's "contributor version". + + A contributor's "essential patent claims" are all patent claims +owned or controlled by the contributor, whether already acquired or +hereafter acquired, that would be infringed by some manner, permitted +by this License, of making, using, or selling its contributor version, +but do not include claims that would be infringed only as a +consequence of further modification of the contributor version. For +purposes of this definition, "control" includes the right to grant +patent sublicenses in a manner consistent with the requirements of +this License. + + Each contributor grants you a non-exclusive, worldwide, royalty-free +patent license under the contributor's essential patent claims, to +make, use, sell, offer for sale, import and otherwise run, modify and +propagate the contents of its contributor version. + + In the following three paragraphs, a "patent license" is any express +agreement or commitment, however denominated, not to enforce a patent +(such as an express permission to practice a patent or covenant not to +sue for patent infringement). To "grant" such a patent license to a +party means to make such an agreement or commitment not to enforce a +patent against the party. + + If you convey a covered work, knowingly relying on a patent license, +and the Corresponding Source of the work is not available for anyone +to copy, free of charge and under the terms of this License, through a +publicly available network server or other readily accessible means, +then you must either (1) cause the Corresponding Source to be so +available, or (2) arrange to deprive yourself of the benefit of the +patent license for this particular work, or (3) arrange, in a manner +consistent with the requirements of this License, to extend the patent +license to downstream recipients. "Knowingly relying" means you have +actual knowledge that, but for the patent license, your conveying the +covered work in a country, or your recipient's use of the covered work +in a country, would infringe one or more identifiable patents in that +country that you have reason to believe are valid. + + If, pursuant to or in connection with a single transaction or +arrangement, you convey, or propagate by procuring conveyance of, a +covered work, and grant a patent license to some of the parties +receiving the covered work authorizing them to use, propagate, modify +or convey a specific copy of the covered work, then the patent license +you grant is automatically extended to all recipients of the covered +work and works based on it. + + A patent license is "discriminatory" if it does not include within +the scope of its coverage, prohibits the exercise of, or is +conditioned on the non-exercise of one or more of the rights that are +specifically granted under this License. You may not convey a covered +work if you are a party to an arrangement with a third party that is +in the business of distributing software, under which you make payment +to the third party based on the extent of your activity of conveying +the work, and under which the third party grants, to any of the +parties who would receive the covered work from you, a discriminatory +patent license (a) in connection with copies of the covered work +conveyed by you (or copies made from those copies), or (b) primarily +for and in connection with specific products or compilations that +contain the covered work, unless you entered into that arrangement, +or that patent license was granted, prior to 28 March 2007. + + Nothing in this License shall be construed as excluding or limiting +any implied license or other defenses to infringement that may +otherwise be available to you under applicable patent law. + + 12. No Surrender of Others' Freedom. + + If conditions are imposed on you (whether by court order, agreement or +otherwise) that contradict the conditions of this License, they do not +excuse you from the conditions of this License. If you cannot convey a +covered work so as to satisfy simultaneously your obligations under this +License and any other pertinent obligations, then as a consequence you may +not convey it at all. For example, if you agree to terms that obligate you +to collect a royalty for further conveying from those to whom you convey +the Program, the only way you could satisfy both those terms and this +License would be to refrain entirely from conveying the Program. + + 13. Remote Network Interaction; Use with the GNU General Public License. + + Notwithstanding any other provision of this License, if you modify the +Program, your modified version must prominently offer all users +interacting with it remotely through a computer network (if your version +supports such interaction) an opportunity to receive the Corresponding +Source of your version by providing access to the Corresponding Source +from a network server at no charge, through some standard or customary +means of facilitating copying of software. This Corresponding Source +shall include the Corresponding Source for any work covered by version 3 +of the GNU General Public License that is incorporated pursuant to the +following paragraph. + + Notwithstanding any other provision of this License, you have +permission to link or combine any covered work with a work licensed +under version 3 of the GNU General Public License into a single +combined work, and to convey the resulting work. The terms of this +License will continue to apply to the part which is the covered work, +but the work with which it is combined will remain governed by version +3 of the GNU General Public License. + + 14. Revised Versions of this License. + + The Free Software Foundation may publish revised and/or new versions of +the GNU Affero General Public License from time to time. Such new versions +will be similar in spirit to the present version, but may differ in detail to +address new problems or concerns. + + Each version is given a distinguishing version number. If the +Program specifies that a certain numbered version of the GNU Affero General +Public License "or any later version" applies to it, you have the +option of following the terms and conditions either of that numbered +version or of any later version published by the Free Software +Foundation. If the Program does not specify a version number of the +GNU Affero General Public License, you may choose any version ever published +by the Free Software Foundation. + + If the Program specifies that a proxy can decide which future +versions of the GNU Affero General Public License can be used, that proxy's +public statement of acceptance of a version permanently authorizes you +to choose that version for the Program. + + Later license versions may give you additional or different +permissions. However, no additional obligations are imposed on any +author or copyright holder as a result of your choosing to follow a +later version. + + 15. Disclaimer of Warranty. + + THERE IS NO WARRANTY FOR THE PROGRAM, TO THE EXTENT PERMITTED BY +APPLICABLE LAW. EXCEPT WHEN OTHERWISE STATED IN WRITING THE COPYRIGHT +HOLDERS AND/OR OTHER PARTIES PROVIDE THE PROGRAM "AS IS" WITHOUT WARRANTY +OF ANY KIND, EITHER EXPRESSED OR IMPLIED, INCLUDING, BUT NOT LIMITED TO, +THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR +PURPOSE. THE ENTIRE RISK AS TO THE QUALITY AND PERFORMANCE OF THE PROGRAM +IS WITH YOU. SHOULD THE PROGRAM PROVE DEFECTIVE, YOU ASSUME THE COST OF +ALL NECESSARY SERVICING, REPAIR OR CORRECTION. + + 16. Limitation of Liability. + + IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING +WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MODIFIES AND/OR CONVEYS +THE PROGRAM AS PERMITTED ABOVE, BE LIABLE TO YOU FOR DAMAGES, INCLUDING ANY +GENERAL, SPECIAL, INCIDENTAL OR CONSEQUENTIAL DAMAGES ARISING OUT OF THE +USE OR INABILITY TO USE THE PROGRAM (INCLUDING BUT NOT LIMITED TO LOSS OF +DATA OR DATA BEING RENDERED INACCURATE OR LOSSES SUSTAINED BY YOU OR THIRD +PARTIES OR A FAILURE OF THE PROGRAM TO OPERATE WITH ANY OTHER PROGRAMS), +EVEN IF SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE POSSIBILITY OF +SUCH DAMAGES. + + 17. Interpretation of Sections 15 and 16. + + If the disclaimer of warranty and limitation of liability provided +above cannot be given local legal effect according to their terms, +reviewing courts shall apply local law that most closely approximates +an absolute waiver of all civil liability in connection with the +Program, unless a warranty or assumption of liability accompanies a +copy of the Program in return for a fee. + + END OF TERMS AND CONDITIONS + + How to Apply These Terms to Your New Programs + + If you develop a new program, and you want it to be of the greatest +possible use to the public, the best way to achieve this is to make it +free software which everyone can redistribute and change under these terms. + + To do so, attach the following notices to the program. It is safest +to attach them to the start of each source file to most effectively +state the exclusion of warranty; and each file should have at least +the "copyright" line and a pointer to where the full notice is found. + + + Copyright (C) + + This program is free software: you can redistribute it and/or modify + it under the terms of the GNU Affero General Public License as published by + the Free Software Foundation, either version 3 of the License, or + (at your option) any later version. + + This program is distributed in the hope that it will be useful, + but WITHOUT ANY WARRANTY; without even the implied warranty of + MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the + GNU Affero General Public License for more details. + + You should have received a copy of the GNU Affero General Public License + along with this program. If not, see . + +Also add information on how to contact you by electronic and paper mail. + + If your software can interact with users remotely through a computer +network, you should also make sure that it provides a way for users to +get its source. For example, if your program is a web application, its +interface could display a "Source" link that leads users to an archive +of the code. There are many ways you could offer source, and different +solutions will be better for different programs; see section 13 for the +specific requirements. + + You should also get your employer (if you work as a programmer) or school, +if any, to sign a "copyright disclaimer" for the program, if necessary. +For more information on this, and how to apply and follow the GNU AGPL, see +. diff --git a/Makefile b/Makefile new file mode 100644 index 0000000..c6d23db --- /dev/null +++ b/Makefile @@ -0,0 +1,145 @@ +# https://github.com/nextcloud/appstore/blob/fixed-templates/nextcloudappstore/scaffolding/app-templates/26/app/Makefile + +app_name=$(notdir $(CURDIR)) +build_tools_directory=$(CURDIR)/build/tools +source_build_directory=$(CURDIR)/build/artifacts/source +source_package_name=$(source_build_directory)/$(app_name) +appstore_build_directory=$(CURDIR)/build/artifacts +appstore_package_name=$(appstore_build_directory)/$(app_name) +npm=$(shell which npm 2> /dev/null) +composer=$(shell which composer 2> /dev/null) + +all: build + +# Fetches the PHP and JS dependencies and compiles the JS. If no composer.json +# is present, the composer step is skipped, if no package.json or js/package.json +# is present, the npm step is skipped +.PHONY: build +build: +ifneq (,$(wildcard $(CURDIR)/composer.json)) + make composer +endif +ifneq (,$(wildcard $(CURDIR)/package.json)) + make npm +endif + +# Installs and updates the composer dependencies. If composer is not installed +# a copy is fetched from the web +.PHONY: composer +composer: +ifeq (, $(composer)) + @echo "No composer command available, downloading a copy from the web" + mkdir -p $(build_tools_directory) + curl -sS https://getcomposer.org/installer | php + mv composer.phar $(build_tools_directory) + php $(build_tools_directory)/composer.phar install --prefer-dist +else + composer install --prefer-dist +endif + +# Installs npm dependencies +.PHONY: npm +npm: + npm ci + npm run build + +# Removes the appstore build +.PHONY: clean +clean: + rm -rf ./build + +# Same as clean but also removes dependencies installed by composer, bower and +# npm +.PHONY: distclean +distclean: clean + rm -rf vendor + rm -rf node_modules + rm -rf js/vendor + rm -rf js/node_modules + +# Builds the source and appstore package +.PHONY: dist +dist: build + make source + make appstore + +# Builds the source package +.PHONY: source +source: + rm -rf $(source_build_directory) + mkdir -p $(source_build_directory) + tar -C .. -cvzf $(source_package_name).tar.gz \ + --exclude-vcs \ + --exclude="$(app_name)/build" \ + --exclude="$(app_name)/js/node_modules" \ + --exclude="$(app_name)/node_modules" \ + --exclude="$(app_name)/*.log" \ + --exclude="$(app_name)/js/*.log" \ + $(app_name) + +# Builds the source package for the app store, ignores php tests, js tests +# and build related folders that are unnecessary for an appstore release +.PHONY: appstore +appstore: + rm -rf $(appstore_build_directory) + mkdir -p $(appstore_build_directory) + tar -C .. -cvzf $(appstore_package_name).tar.gz \ + --exclude="$(app_name)/build" \ + --exclude="$(app_name)/tests" \ + --exclude="$(app_name)/Makefile" \ + --exclude="$(app_name)/*.log" \ + --exclude="$(app_name)/phpunit*xml" \ + --exclude="$(app_name)/composer.*" \ + --exclude="$(app_name)/node_modules" \ + --exclude="$(app_name)/js/node_modules" \ + --exclude="$(app_name)/js/tests" \ + --exclude="$(app_name)/js/test" \ + --exclude="$(app_name)/js/*.log" \ + --exclude="$(app_name)/js/package.json" \ + --exclude="$(app_name)/js/bower.json" \ + --exclude="$(app_name)/js/karma.*" \ + --exclude="$(app_name)/js/protractor.*" \ + --exclude="$(app_name)/package.json" \ + --exclude="$(app_name)/bower.json" \ + --exclude="$(app_name)/karma.*" \ + --exclude="$(app_name)/protractor\.*" \ + --exclude="$(app_name)/.*" \ + --exclude="$(app_name)/js/.*" \ + --exclude="$(app_name)/tsconfig.json" \ + --exclude="$(app_name)/stylelint.config.cjs" \ + --exclude="$(app_name)/README.md" \ + --exclude="$(app_name)/package-lock.json" \ + --exclude="$(app_name)/LICENSE" \ + --exclude="$(app_name)/src" \ + --exclude="$(app_name)/stubs" \ + --exclude="$(app_name)/screens" \ + --exclude="$(app_name)/vendor" \ + --exclude="$(app_name)/translationfiles" \ + --exclude="$(app_name)/Dockerfile" \ + --exclude="$(app_name)/psalm.xml" \ + --exclude="$(app_name)/renovate.json" \ + --exclude="$(app_name)/vite.config.ts" \ + $(app_name) + +# Start a nextcloud server on Docker to kickstart developement +.PHONY: dev +dev: build + docker stop $(app_name) || true + docker rm $(app_name) || true + docker build -t $(app_name) . + docker run -itd --rm --name $(app_name) -v $(CURDIR):/var/www/html/apps/$(app_name) -p 80:80 $(app_name) + npm run watch || docker stop $(app_name) + +# Generate translations +.PHONY: l10n +l10n: + docker run --rm \ + -v $(CURDIR):/app \ + --entrypoint php \ + nextcloudci/translations \ + /translationtool.phar create-pot-files + docker run --rm \ + -v $(CURDIR):/app \ + --entrypoint php \ + nextcloudci/translations \ + /translationtool.phar convert-po-files diff --git a/README.md b/README.md new file mode 100644 index 0000000..073c8a3 --- /dev/null +++ b/README.md @@ -0,0 +1,25 @@ +# App Template + +A template to get started with Nextcloud app development. + +## Usage + +- To get started easily use the [Appstore App generator](https://apps.nextcloud.com/developer/apps/generate) to + dynamically generate an App based on this repository with all the constants prefilled. +- Alternatively you can use the "Use this template" button on the top of this page to create a new repository based on + this repository. Afterwards adjust all the necessary constants like App ID, namespace, descriptions etc. + +Once your app is ready follow the [instructions](https://nextcloudappstore.readthedocs.io/en/latest/developer.html) to +upload it to the Appstore. + +## Resources + +### Documentation for developers: + +- General documentation and tutorials: https://nextcloud.com/developer +- Technical documentation: https://docs.nextcloud.com/server/latest/developer_manual + +### Help for developers: + +- Official community chat: https://cloud.nextcloud.com/call/xs25tz5y +- Official community forum: https://help.nextcloud.com/c/dev/11 diff --git a/appinfo/info.xml b/appinfo/info.xml new file mode 100644 index 0000000..d8ffe1e --- /dev/null +++ b/appinfo/info.xml @@ -0,0 +1,27 @@ + + + retro + Retro + An example summary + An example description + 1.0.0 + agpl + Example + AppTemplate + customization + https://example.com/bugs + + + + + + + retro + Games + retro.page.index + app.svg + link + + + diff --git a/composer.json b/composer.json new file mode 100644 index 0000000..efcda13 --- /dev/null +++ b/composer.json @@ -0,0 +1,42 @@ +{ + "name": "nextcloud/retro", + "description": "An example description", + "license": "AGPL-3.0-or-later", + "authors": [ + { + "name": "example", + "email": "example@example.com", + "homepage": "https://example.com" + } + ], + "autoload": { + "psr-4": { + "OCA\\AppTemplate\\": "lib/" + } + }, + "scripts": { + "lint": "find . -name \\*.php -not -path './vendor/*' -not -path './vendor-bin/*' -not -path './build/*' -print0 | xargs -0 -n1 php -l", + "cs:check": "php-cs-fixer fix --dry-run --diff", + "cs:fix": "php-cs-fixer fix", + "psalm": "psalm --threads=1 --no-cache --show-info=true", + "rector": "rector && composer cs:fix" + }, + "require": { + "php": "^8.1" + }, + "require-dev": { + "nextcloud/ocp": "^30.0.4", + "roave/security-advisories": "dev-latest", + "nextcloud/coding-standard": "^1.3.2", + "nextcloud/rector": "^0.2.1", + "rector/rector": "^2.0.3", + "vimeo/psalm": "^5.26.1" + }, + "config": { + "optimize-autoloader": true, + "sort-packages": true, + "platform": { + "php": "8.1" + } + } +} diff --git a/img/app-dark.svg b/img/app-dark.svg new file mode 100644 index 0000000..7c6ab6d --- /dev/null +++ b/img/app-dark.svg @@ -0,0 +1 @@ + \ No newline at end of file diff --git a/img/app.svg b/img/app.svg new file mode 100644 index 0000000..9da6665 --- /dev/null +++ b/img/app.svg @@ -0,0 +1 @@ + \ No newline at end of file diff --git a/lib/AppInfo/Application.php b/lib/AppInfo/Application.php new file mode 100644 index 0000000..d22c540 --- /dev/null +++ b/lib/AppInfo/Application.php @@ -0,0 +1,23 @@ + + * + * 200: Data returned + */ + #[NoAdminRequired] + #[ApiRoute(verb: 'GET', url: '/api')] + public function index(): DataResponse { + return new DataResponse( + ['message' => 'Hello world!'] + ); + } +} diff --git a/lib/Controller/PageController.php b/lib/Controller/PageController.php new file mode 100644 index 0000000..ed26018 --- /dev/null +++ b/lib/Controller/PageController.php @@ -0,0 +1,27 @@ + + + + + + + + + + + + diff --git a/rector.php b/rector.php new file mode 100644 index 0000000..b7d34ea --- /dev/null +++ b/rector.php @@ -0,0 +1,34 @@ +withPaths([ + __DIR__.'/appinfo', + __DIR__.'/lib', + ]) + ->withPhpSets(php81: true) + ->withSets([ + NextcloudSets::NEXTCLOUD_27, + ]) + ->withPreparedSets( + deadCode: true, + codeQuality: true, + codingStyle: true, + typeDeclarations: true, + privatization: true, + instanceOf: true, + earlyReturn: true, + strictBooleans: true, + rectorPreset: true, + phpunitCodeQuality: true, + doctrineCodeQuality: true, + symfonyCodeQuality: true, + symfonyConfigs: true, + twig: true, + phpunit: true, + ) +; diff --git a/renovate.json b/renovate.json new file mode 100644 index 0000000..44fed31 --- /dev/null +++ b/renovate.json @@ -0,0 +1,4 @@ +{ + "$schema": "https://docs.renovatebot.com/renovate-schema.json", + "rangeStrategy": "bump" +} diff --git a/src/App.vue b/src/App.vue new file mode 100644 index 0000000..c32767d --- /dev/null +++ b/src/App.vue @@ -0,0 +1,26 @@ + + + + + diff --git a/src/main.ts b/src/main.ts new file mode 100644 index 0000000..a967303 --- /dev/null +++ b/src/main.ts @@ -0,0 +1,6 @@ +import '@formatjs/intl-segmenter/polyfill' +import { createApp } from 'vue' +import App from './App.vue' + +const View = createApp(App) +View.mount('#retro') diff --git a/stylelint.config.cjs b/stylelint.config.cjs new file mode 100644 index 0000000..3be3a7b --- /dev/null +++ b/stylelint.config.cjs @@ -0,0 +1,3 @@ +module.exports = { + extends: 'stylelint-config-recommended-vue', +} diff --git a/templates/index.php b/templates/index.php new file mode 100644 index 0000000..81ae98a --- /dev/null +++ b/templates/index.php @@ -0,0 +1 @@ +
diff --git a/tsconfig.json b/tsconfig.json new file mode 100644 index 0000000..cd4df6e --- /dev/null +++ b/tsconfig.json @@ -0,0 +1,15 @@ +{ + "extends": "@vue/tsconfig", + "include": ["./src/**/*.ts", "./src/**/*.vue", "**/*.ts"], + "compilerOptions": { + "allowImportingTsExtensions": true, + "allowSyntheticDefaultImports": true, + "target": "ESNext", + "module": "ESNext", + "moduleResolution": "Bundler", + "noImplicitAny": false, + "rootDir": ".", + "strict": true, + "noEmit": true, + } +} diff --git a/vite.config.ts b/vite.config.ts new file mode 100644 index 0000000..0b5a65d --- /dev/null +++ b/vite.config.ts @@ -0,0 +1,20 @@ +import { join, resolve } from 'path' +import { createAppConfig } from '@nextcloud/vite-config' +import { defineConfig } from 'vite' + +const config = defineConfig({ + build: { + sourcemap: false, + }, +}) + +export default createAppConfig( + { + main: resolve(join('src', 'main.ts')), + }, + { + config, + createEmptyCSSEntryPoints: true, + thirdPartyLicense: false, + }, +)