-
-
Notifications
You must be signed in to change notification settings - Fork 0
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
Showing
3 changed files
with
76 additions
and
113 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,33 @@ | ||
| name: PHPStan | ||
|
|
||
| on: | ||
| push: | ||
| branches: [5.0] | ||
| pull_request: | ||
| branches: [5.0] | ||
| workflow_dispatch: | ||
|
|
||
| jobs: | ||
| PHPStan: | ||
|
|
||
| strategy: | ||
| fail-fast: false | ||
| matrix: | ||
| php_versions: ['8.1', '8.2', '8.3'] | ||
|
|
||
| runs-on: ubuntu-latest | ||
| name: PHPStan - ${{ matrix.php_versions }} | ||
|
|
||
| steps: | ||
| - uses: actions/checkout@v3 | ||
|
|
||
| - name: Setup PHP, with composer and extensions | ||
| uses: shivammathur/setup-php@v2 | ||
| with: | ||
| php-version: ${{ matrix.php_versions }} | ||
|
|
||
| - name: Install Dependencies | ||
| run: composer install --no-ansi --no-interaction --no-scripts --no-progress --prefer-dist | ||
|
|
||
| - name: Run PHPStan | ||
| run: vendor/bin/phpstan analyse |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,126 +1,56 @@ | ||
| # UserFrosting 5.1 | ||
| # Recipe : Adding a 3rd party Javascript package (UserFrosting 5) | ||
|
|
||
| [](https://github.com/userfrosting/UserFrosting/releases) | ||
| [](https://github.com/userfrosting/recipe-js-package/releases) | ||
|  | ||
| [](https://github.com/userfrosting/UserFrosting/actions) | ||
| [](https://codecov.io/gh/userfrosting/userfrosting) | ||
| [](https://github.styleci.io/repos/18148206) | ||
| [](LICENSE.md) | ||
| [](https://chat.userfrosting.com/channel/support) | ||
| [](#backers) | ||
| [](#sponsors) | ||
| [](LICENSE.md) | ||
| [](https://github.com/userfrosting/recipe-js-package/actions) | ||
| [](https://app.codecov.io/gh/userfrosting/recipe-js-package/branch/5.0) | ||
| [](https://github.styleci.io/repos/793283029) | ||
| [](https://github.com/userfrosting/recipe-js-package/actions/workflows/PHPStan.yml) | ||
| [](https://chat.userfrosting.com) | ||
| [](https://opencollective.com/userfrosting#backer) | ||
| [](https://ko-fi.com/lcharette) | ||
|
|
||
| [https://www.userfrosting.com](https://www.userfrosting.com) | ||
| Example sprinkle for adding a 3rd party Javascript package. [See the learn documentation for more information](http://learn.userfrosting.com/recipes/external-js). | ||
|
|
||
| # Installation | ||
|
|
||
| If you simply want to show that you like this project, or want to remember it for later, you should **star**, not **fork**, this repository. Forking is only for when you are ready to create your own copy of the code to work on. | ||
| This sprinkle/example can be installed like any UserFrosting application or skeleton. See the [installation guide](https://learn.userfrosting.com/installation) for the required config and more info on the installation steps. | ||
|
|
||
| ## By [Alex Weissman](https://alexanderweissman.com) and [Louis Charette](https://bbqsoftwares.com) | ||
| ## Quick start | ||
|
|
||
| Copyright (c) 2013-2024, free to use in personal and commercial software as per the [license](LICENSE.md). | ||
| ```bash | ||
| git clone https://github.com/userfrosting/recipe-js-package.git | ||
| cd recipe-js-package | ||
| composer install | ||
| php bakery bake | ||
| php bakery serve | ||
| ``` | ||
|
|
||
| UserFrosting is a secure, modern user management system written in PHP and built on top of the [Slim Microframework](http://www.slimframework.com/), [Twig](http://twig.sensiolabs.org/) templating engine, and [Eloquent](https://laravel.com/docs/10.x/eloquent#introduction) ORM. | ||
| You can now access UserFrosting at : http://localhost:8080 | ||
|
|
||
| ## Features | ||
| ## Docker | ||
|
|
||
| ### User login screen | ||
|  | ||
| To run inside docker : | ||
| ```bash | ||
| git clone https://github.com/userfrosting/recipe-js-package.git | ||
| cd recipe-js-package | ||
| docker-compose build --no-cache | ||
| docker-compose up -d | ||
| docker-compose exec app composer install | ||
| docker-compose exec app php bakery bake | ||
| ``` | ||
|
|
||
| ### User management page | ||
|  | ||
|
|
||
| ### Permissions management page | ||
|  | ||
|
|
||
| ## [Demo](https://demo.userfrosting.com) | ||
|
|
||
| ## Installation | ||
|
|
||
| Please see our [installation guide](https://learn.userfrosting.com/installation). | ||
|
|
||
| ## Troubleshooting | ||
|
|
||
| If you are having trouble installing UserFrosting, please [join us in chat](https://chat.userfrosting.com). | ||
|
|
||
| If you are generally confused about the structure and layout of the code, or it doesn't look like the kind of PHP code that you're used to, please [start from the beginning](https://learn.userfrosting.com/background). | ||
|
|
||
| ## Mission Objectives | ||
|
|
||
| UserFrosting seeks to balance modern programming principles, like DRY and MVC, with a shallow learning curve for new developers. Our goals are to: | ||
|
|
||
| - Create a fully-functioning user management script that can be set up in just a few minutes | ||
| - Make it easy for users to quickly adapt the code for their needs | ||
| - Introduce novice developers to best practices such as separation of concerns and DRY programming | ||
| - Introduce novice developers to modern constructs such as front-end controllers, RESTful URLs, namespacing, and object-oriented modeling | ||
| - Build on existing, widely used server- and client-side components | ||
| - Clean, consistent, and well-documented code | ||
| You can now access UserFrosting at : http://localhost:8080 | ||
|
|
||
| ## Documentation | ||
|
|
||
| ### [Learning UserFrosting](https://learn.userfrosting.com) | ||
|
|
||
| ### [API documentation](http://api.userfrosting.com) | ||
|
|
||
| ### [Change log](CHANGELOG.md) | ||
|
|
||
| ## Development Team | ||
|
|
||
| ### Alexander Weissman | ||
|
|
||
| Alex is the founder and co-owner of two companies, one that does [math tutoring at Indiana University](https://bloomingtontutors.com) in Bloomington, IN and another company that does [math tutoring at UMD](https://collegeparktutors.com) in College Park, MD. He is a PhD student in the School of Informatics and Computing at Indiana University. | ||
|
|
||
| ### Louis Charette | ||
|
|
||
| Louis's a civil engineer in Montréal, Québec who also has a passion for coding. He was one of the main contributors for SimpsonsCity.com and likes to share his knowledge by helping others the same way he was helped when he first started coding. | ||
|
|
||
| ### Jordan Mele | ||
|
|
||
| Jordan's an Australian Software Engineer at [Canva](https://canva.com). His passion is creating simple yet intuitive software-based solutions for problems that would otherwise be tedious and/or difficult to solve, while keeping the user in control. | ||
|
|
||
| ### Sarah Baghdadi | ||
|
|
||
| Sarah is UserFrosting's UX specialist and frontend designer. In addition to her work on the UF application itself, she is responsible for the amazing design of https://www.userfrosting.com and https://learn.userfrosting.com. | ||
|
|
||
| ### Srinivas Nukala | ||
|
|
||
| Srinivas's a web applications architect, with a passion for open source technologies. He is experienced in building SaaS (software as a service) web applications and enjoys working on open source projects and contributing to the community. He has a Masters in Computer Science from Pune University, India. | ||
| - [Changelog](CHANGELOG.md) | ||
| - [Issues](https://github.com/userfrosting/UserFrosting/issues) | ||
| - [License](LICENSE.md) | ||
| - [Style Guide](https://github.com/userfrosting/.github/blob/main/.github/STYLE-GUIDE.md) | ||
|
|
||
| ## Contributing | ||
|
|
||
| This project exists thanks to all the people who contribute. If you're interested in contributing to the UserFrosting codebase, please see our [contributing guidelines](https://github.com/userfrosting/.github/blob/main/.github/CONTRIBUTING.md) as well as our [style guidelines](https://github.com/userfrosting/.github/blob/main/.github/STYLE-GUIDE.md). | ||
|
|
||
| [](https://github.com/userfrosting/UserFrosting/graphs/contributors) | ||
|
|
||
| ### Thanks to our translators! | ||
|
|
||
| - Louis Charette (@lcharette) - French | ||
| - Karuhut Komol (@popiazaza) - Thai | ||
| - Pietro Marangon (@Pe46dro) - Italian | ||
| - Christian la Forgia (@optiroot) - Italian | ||
| - Abdullah Seba (@abdullahseba) - Arabic | ||
| - Bruno Silva (@brunomnsilva) - Portuguese | ||
| - @BruceGui - Chinese | ||
| - @kevinrombach - German | ||
| - @rafa31gz - Spanish | ||
| - @splitt3r - German | ||
| - @X-Anonymous-Y - German | ||
| - Dmitriy (@rendername) - Russian | ||
| - Amin Akbari (@aminakbari) - Farsi | ||
| - Dumblledore - Turkish | ||
| - Lena Stergatou (@lenasterg) - Greek | ||
|
|
||
| ## Supporting UserFrosting | ||
|
|
||
| ### Backers | ||
|
|
||
| Backers help us continue to develop UserFrosting by pledging a regular monthly contribution of $5 or more. [[Become a backer](https://opencollective.com/userfrosting#contribute)] | ||
|
|
||
| <a href="https://opencollective.com/userfrosting#backers" target="_blank"><img src="https://opencollective.com/userfrosting/backers.svg?width=890"></a> | ||
|
|
||
| #### Sponsors | ||
|
|
||
| Support this project by becoming a sponsor. Sponsors have contributed a total of $500 or more to UserFrosting (either as an ongoing backer or one-time contributions). Your logo will show up here with a link to your website. [[Become a sponsor](https://opencollective.com/userfrosting#sponsor)] | ||
|
|
||
| [](https://usorgames.com) | ||
| [](https://nextgi.com) | ||
| [](https://github.com/userfrosting/sprinkle-core/graphs/contributors) |