Skip to content

Latest commit

 

History

History
50 lines (36 loc) · 2.11 KB

README.md

File metadata and controls

50 lines (36 loc) · 2.11 KB

Auth

Generates pages and administration used for authentication. Auth deals with authenticating users via signup and login. It also sends verification emails, has forgot and re-verify flows. Auth is built on top of system, so it inherits all of its admin functionality as well.

  • Sign Up Form
  • Verify Account Form
  • Log In Form
  • Forgot Password Form
  • Recover Password Form

Install

If you already installed Cradle, you may not need to install this because it should be already included.

$ composer require cradlephp/cradle-auth
$ bin/cradle cradlephp/cradle-auth install
$ bin/cradle cradlephp/cradle-auth sql-populate

Contributing to Cradle PHP

Thank you for considering to contribute to Cradle PHP.

Please DO NOT create issues in this repository. The official issue tracker is located @ https://github.com/CradlePHP/cradle/issues . Any issues created here will most likely be ignored.

Please be aware that master branch contains all edge releases of the current version. Please check the version you are working with and find the corresponding branch. For example v1.1.1 can be in the 1.1 branch.

Bug fixes will be reviewed as soon as possible. Minor features will also be considered, but give me time to review it and get back to you. Major features will only be considered on the master branch.

  1. Fork the Repository.
  2. Fire up your local terminal and switch to the version you would like to contribute to.
  3. Make your changes.
  4. Always make sure to sign-off (-s) on all commits made (git commit -s -m "Commit message")

Making pull requests

  1. Please ensure to run phpunit and phpcs before making a pull request.
  2. Push your code to your remote forked version.
  3. Go back to your forked version on GitHub and submit a pull request.
  4. All pull requests will be passed to Travis CI to be tested. Also note that Coveralls is also used to analyze the coverage of your contribution.