Skip to content

Commit

Permalink
Update README
Browse files Browse the repository at this point in the history
  • Loading branch information
lcharette committed Nov 12, 2023
1 parent ea03c20 commit 6f477a6
Show file tree
Hide file tree
Showing 6 changed files with 48 additions and 170 deletions.
142 changes: 0 additions & 142 deletions .github/CONTRIBUTING.md

This file was deleted.

2 changes: 1 addition & 1 deletion .github/FUNDING.yml
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@
github: # Replace with up to 4 GitHub Sponsors-enabled usernames e.g., [user1, user2]
patreon: # Replace with a single Patreon username
open_collective: userfrosting # Replace with a single Open Collective username
ko_fi: # Replace with a single Ko-fi username
ko_fi: lcharette # Replace with a single Ko-fi username
tidelift: # Replace with a single Tidelift platform-name/package-name e.g., npm/babel
community_bridge: # Replace with a single Community Bridge project-name e.g., cloud-foundry
liberapay: # Replace with a single Liberapay username
Expand Down
19 changes: 1 addition & 18 deletions .github/ISSUE_TEMPLATE.md
Original file line number Diff line number Diff line change
@@ -1,19 +1,2 @@
🛑 STOP!

Before you open an issue:

1. Make sure that your issue is a BUG or FEATURE REQUEST. General usage and troubleshooting questions should be directed to the [forums](https://forums.userfrosting.com), [chat](https://chat.userfrosting.com), or [Stack Overflow](https://stackoverflow.com/questions/tagged/userfrosting). You can also consult our chapter on [common problems](https://learn.userfrosting.com/troubleshooting/common-problems). Issues asking for general support WILL BE CLOSED automatically.
2. Search the forums and current issues, both open and closed, for a similar issue. If the bug is still present but the relevant issue has been closed, you may ask us to reopen the issue. Duplicate issues will be closed automatically.
3. Make sure that you are using the latest stable version of UserFrosting (see the [release history](https://github.com/userfrosting/UserFrosting/releases)). Support for UserFrosting 3.x or earlier may be limited.

If you are CERTAIN that it is appropriate to open a new issue, you must:

1. Format any code snippets or command-line output using Markdown [code fences](https://help.github.com/articles/creating-and-highlighting-code-blocks/), and make sure your code is properly indented. **This is extremely important** - poorly formatted code is difficult to read and reflects badly on you as a programmer.
2. Remember that courtesy and proper grammar go a long way. Please take the time to craft a precise, polite issue. We will do our best to help, but remember that this is an open-source project - none of us are getting paid a salary to develop this project, or act as your personal support hotline ;-)
1. State the steps needed to reproduce the problem.
2. Mention your version of UserFrosting, as well as the browser(s) and operating system(s) in which the problem occurs.
3. Report any errors in detail. Vague issues like "it doesn't work when I do this" are not helpful. Show that you have put some effort into identifying the cause of the error. See the section on [debugging](https://learn.userfrosting.com/troubleshooting/debugging) for information on how to get more details about errors and other problems.
3. You should always test your code in a local development environment, to separate code-related issues from server issues. In general, we recommend that you install a local development server on your computer, rather than testing your code directly on the production server. This means you can test your code directly on your own computer, making development faster and without the risk of exposing sensitive information to the public. We recommend installing Vagrant and Homestead if you don't already have a local server set up.
4. If you are not conversationally proficient in English, do NOT just post a machine translation (e.g. Google Translate) to GitHub. Get help in crafting your question, either via the [forums](https://forums.userfrosting.com) or in [chat](https://chat.userfrosting.com). If all else fails, you may post your bug report or feature request in your native language, with a machine translation below that. We will tag it with `translation-needed` so that others who speak your language can find it.
5. Clear out this placeholder text.
6. Consider supporting this project by [making a donation to our Open Collective](https://opencollective.com/userfrosting/donate)!
Issues should be opened on the main repo : https://github.com/userfrosting/UserFrosting/issues
49 changes: 44 additions & 5 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,11 +8,50 @@
[![StyleCI](https://github.styleci.io/repos/448371817/shield?branch=5.0&style=flat)](https://github.styleci.io/repos/448371817)
[![PHPStan](https://img.shields.io/github/actions/workflow/status/userfrosting/sprinkle-account/PHPStan.yml?branch=5.0&label=PHPStan)](https://github.com/userfrosting/sprinkle-account/actions/workflows/PHPStan.yml)
[![Join the chat](https://img.shields.io/badge/Chat-UserFrosting-brightgreen?logo=Rocket.Chat)](https://chat.userfrosting.com)
[![Donate](https://img.shields.io/badge/Open%20Collective-Donate-blue.svg)](https://opencollective.com/userfrosting#backer)
[![Donate](https://img.shields.io/badge/Open_Collective-Donate-blue?logo=Open%20Collective
)](https://opencollective.com/userfrosting#backer)
[![Donate](https://img.shields.io/badge/Ko--fi-Donate-blue?logo=ko-fi&logoColor=white
)](https://ko-fi.com/lcharette)

<!-- [![Latest Version](https://img.shields.io/github/release/userfrosting/sprinkle-account.svg)](https://github.com/userfrosting/sprinkle-account/releases) -->
## By [Alex Weissman](https://alexanderweissman.com) and [Louis Charette](https://bbqsoftwares.com)

<!-- ![PHP](https://img.shields.io/packagist/php-v/userfrosting/sprinkle-account/dev-develop-5.0?color=brightgreen) -->
Copyright (c) 2019-2023, free to use in personal and commercial software as per the [license](LICENSE.md).

## _This is a work in progress_
Documentation coming soon.
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/5.8/eloquent#introduction) ORM.

This **Account sprinkle** handles user modeling and authentication, user groups, roles, and access control. It contains the routes, templates, and controllers needed to implement pages for registration, password reset, login, and more.

## Installation
1. Require in your [UserFrosting](https://github.com/userfrosting/UserFrosting) project :
```
composer require userfrosting/sprinkle-account
```
2. Add the Sprinkle to your Sprinkle Recipe :
```php
public function getSprinkles(): array
{
return [
\UserFrosting\Sprinkle\Account\Account::class,
];
}
```
3. Bake
```bash
php bakery bake
```
## Documentation
See main [UserFrosting Documentation](https://learn.userfrosting.com) for more information.
- [Changelog](CHANGELOG.md)
- [Issues](https://github.com/userfrosting/UserFrosting/issues)
- [License](LICENSE.md)
- [Style Guide](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/UserFrosting/blob/5.0/.github/CONTRIBUTING.md) as well as our [style guidelines](.github/STYLE-GUIDE.md).
[![](https://opencollective.com/userfrosting/contributors.svg?width=890&button=true)](https://github.com/userfrosting/sprinkle-core/graphs/contributors)
4 changes: 1 addition & 3 deletions app/src/Authorize/AccessConditions.php
Original file line number Diff line number Diff line change
Expand Up @@ -25,11 +25,9 @@
*/
class AccessConditions implements AccessConditionsInterface
{
protected UserInterface $user;

public function __construct(
protected Config $config,
?UserInterface $user = null,
protected ?UserInterface $user = null,
) {
$this->user = $user ?? new User();
}
Expand Down
2 changes: 1 addition & 1 deletion composer.json
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@
"name": "userfrosting/sprinkle-account",
"type": "userfrosting-sprinkle",
"description": "Authentication and account management module for UserFrosting.",
"keywords": ["php user management", "usercake", "bootstrap"],
"keywords": ["php user management", "userfrosting", "sprinkle", "account", "user account", "login"],
"homepage": "https://github.com/userfrosting/UserFrosting",
"license" : "MIT",
"authors" : [
Expand Down

0 comments on commit 6f477a6

Please sign in to comment.