-
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
briankelleher
committed
Dec 7, 2016
1 parent
5e47b6c
commit cbdf289
Showing
53 changed files
with
8,340 additions
and
1 deletion.
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
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,4 +1,5 @@ | ||
api/vendor/ | ||
/api/vendor/* | ||
!/api/vendor/slim/ | ||
|
||
# OS generated files | ||
.DS_Store | ||
|
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,20 @@ | ||
# How to Contribute | ||
|
||
## Pull Requests | ||
|
||
1. Fork the Slim Framework repository | ||
2. Create a new branch for each feature or improvement | ||
3. Send a pull request from each feature branch to the **develop** branch | ||
|
||
It is very important to separate new features or improvements into separate feature branches, and to send a | ||
pull request for each branch. This allows me to review and pull in new features or improvements individually. | ||
|
||
## Style Guide | ||
|
||
All pull requests must adhere to the [PSR-2 standard](https://github.com/php-fig/fig-standards/blob/master/accepted/PSR-2-coding-style-guide.md). | ||
|
||
## Unit Testing | ||
|
||
All pull requests must be accompanied by passing unit tests and complete code coverage. The Slim Framework uses phpunit for testing. | ||
|
||
[Learn about PHPUnit](https://github.com/sebastianbergmann/phpunit/) |
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,19 @@ | ||
Copyright (c) 2011-2016 Josh Lockhart | ||
|
||
Permission is hereby granted, free of charge, to any person obtaining a copy | ||
of this software and associated documentation files (the "Software"), to deal | ||
in the Software without restriction, including without limitation the rights | ||
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell | ||
copies of the Software, and to permit persons to whom the Software is furnished | ||
to do so, subject to the following conditions: | ||
|
||
The above copyright notice and this permission notice shall be included in all | ||
copies or substantial portions of the Software. | ||
|
||
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR | ||
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, | ||
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE | ||
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER | ||
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, | ||
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN | ||
THE SOFTWARE. |
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,84 @@ | ||
# Slim Framework | ||
|
||
[](https://travis-ci.org/slimphp/Slim) | ||
[](https://coveralls.io/r/slimphp/Slim) | ||
[](https://packagist.org/packages/slim/slim) | ||
[](https://packagist.org/packages/slim/slim) | ||
|
||
Slim is a PHP micro-framework that helps you quickly write simple yet powerful web applications and APIs. | ||
|
||
## Installation | ||
|
||
It's recommended that you use [Composer](https://getcomposer.org/) to install Slim. | ||
|
||
```bash | ||
$ composer require slim/slim "^3.0" | ||
``` | ||
|
||
This will install Slim and all required dependencies. Slim requires PHP 5.5.0 or newer. | ||
|
||
## Usage | ||
|
||
Create an index.php file with the following contents: | ||
|
||
```php | ||
<?php | ||
|
||
require 'vendor/autoload.php'; | ||
|
||
$app = new Slim\App(); | ||
|
||
$app->get('/hello/{name}', function ($request, $response, $args) { | ||
$response->write("Hello, " . $args['name']); | ||
return $response; | ||
}); | ||
|
||
$app->run(); | ||
``` | ||
|
||
You may quickly test this using the built-in PHP server: | ||
```bash | ||
$ php -S localhost:8000 | ||
``` | ||
|
||
Going to http://localhost:8000/hello/world will now display "Hello, world". | ||
|
||
For more information on how to configure your web server, see the [Documentation](http://www.slimframework.com/docs/start/web-servers.html). | ||
|
||
## Tests | ||
|
||
To execute the test suite, you'll need phpunit. | ||
|
||
```bash | ||
$ phpunit | ||
``` | ||
|
||
## Contributing | ||
|
||
Please see [CONTRIBUTING](CONTRIBUTING.md) for details. | ||
|
||
## Learn More | ||
|
||
Learn more at these links: | ||
|
||
- [Website](http://www.slimframework.com) | ||
- [Documentation](http://www.slimframework.com/docs/start/installation.html) | ||
- [Support Forum](http://help.slimframework.com) | ||
- [Twitter](https://twitter.com/slimphp) | ||
- [Resources](https://github.com/xssc/awesome-slim) | ||
|
||
## Security | ||
|
||
If you discover security related issues, please email security@slimframework.com instead of using the issue tracker. | ||
|
||
## Credits | ||
|
||
- [Josh Lockhart](https://github.com/codeguy) | ||
- [Andrew Smith](https://github.com/silentworks) | ||
- [Rob Allen](https://github.com/akrabat) | ||
- [Gabriel Manricks](https://github.com/gmanricks) | ||
- [All Contributors](../../contributors) | ||
|
||
## License | ||
|
||
The Slim Framework is licensed under the MIT license. See [License File](LICENSE.md) for more information. |
Oops, something went wrong.