|
1 |
| -<p align="center"><img src="https://res.cloudinary.com/dtfbvvkyp/image/upload/v1566331377/laravel-logolockup-cmyk-red.svg" width="400"></p> |
2 |
| - |
3 |
| -<p align="center"> |
4 |
| -<a href="https://travis-ci.org/laravel/framework"><img src="https://travis-ci.org/laravel/framework.svg" alt="Build Status"></a> |
5 |
| -<a href="https://packagist.org/packages/laravel/framework"><img src="https://poser.pugx.org/laravel/framework/d/total.svg" alt="Total Downloads"></a> |
6 |
| -<a href="https://packagist.org/packages/laravel/framework"><img src="https://poser.pugx.org/laravel/framework/v/stable.svg" alt="Latest Stable Version"></a> |
7 |
| -<a href="https://packagist.org/packages/laravel/framework"><img src="https://poser.pugx.org/laravel/framework/license.svg" alt="License"></a> |
8 |
| -</p> |
9 |
| - |
10 |
| -## About Laravel |
11 |
| - |
12 |
| -Laravel is a web application framework with expressive, elegant syntax. We believe development must be an enjoyable and creative experience to be truly fulfilling. Laravel takes the pain out of development by easing common tasks used in many web projects, such as: |
13 |
| - |
14 |
| -- [Simple, fast routing engine](https://laravel.com/docs/routing). |
15 |
| -- [Powerful dependency injection container](https://laravel.com/docs/container). |
16 |
| -- Multiple back-ends for [session](https://laravel.com/docs/session) and [cache](https://laravel.com/docs/cache) storage. |
17 |
| -- Expressive, intuitive [database ORM](https://laravel.com/docs/eloquent). |
18 |
| -- Database agnostic [schema migrations](https://laravel.com/docs/migrations). |
19 |
| -- [Robust background job processing](https://laravel.com/docs/queues). |
20 |
| -- [Real-time event broadcasting](https://laravel.com/docs/broadcasting). |
21 |
| - |
22 |
| -Laravel is accessible, powerful, and provides tools required for large, robust applications. |
23 |
| - |
24 |
| -## Learning Laravel |
25 |
| - |
26 |
| -Laravel has the most extensive and thorough [documentation](https://laravel.com/docs) and video tutorial library of all modern web application frameworks, making it a breeze to get started with the framework. |
27 |
| - |
28 |
| -If you don't feel like reading, [Laracasts](https://laracasts.com) can help. Laracasts contains over 1500 video tutorials on a range of topics including Laravel, modern PHP, unit testing, and JavaScript. Boost your skills by digging into our comprehensive video library. |
29 |
| - |
30 |
| -## Laravel Sponsors |
31 |
| - |
32 |
| -We would like to extend our thanks to the following sponsors for funding Laravel development. If you are interested in becoming a sponsor, please visit the Laravel [Patreon page](https://patreon.com/taylorotwell). |
33 |
| - |
34 |
| -- **[Vehikl](https://vehikl.com/)** |
35 |
| -- **[Tighten Co.](https://tighten.co)** |
36 |
| -- **[Kirschbaum Development Group](https://kirschbaumdevelopment.com)** |
37 |
| -- **[64 Robots](https://64robots.com)** |
38 |
| -- **[Cubet Techno Labs](https://cubettech.com)** |
39 |
| -- **[Cyber-Duck](https://cyber-duck.co.uk)** |
40 |
| -- **[British Software Development](https://www.britishsoftware.co)** |
41 |
| -- **[Webdock, Fast VPS Hosting](https://www.webdock.io/en)** |
42 |
| -- **[DevSquad](https://devsquad.com)** |
43 |
| -- [UserInsights](https://userinsights.com) |
44 |
| -- [Fragrantica](https://www.fragrantica.com) |
45 |
| -- [SOFTonSOFA](https://softonsofa.com/) |
46 |
| -- [User10](https://user10.com) |
47 |
| -- [Soumettre.fr](https://soumettre.fr/) |
48 |
| -- [CodeBrisk](https://codebrisk.com) |
49 |
| -- [1Forge](https://1forge.com) |
50 |
| -- [TECPRESSO](https://tecpresso.co.jp/) |
51 |
| -- [Runtime Converter](http://runtimeconverter.com/) |
52 |
| -- [WebL'Agence](https://weblagence.com/) |
53 |
| -- [Invoice Ninja](https://www.invoiceninja.com) |
54 |
| -- [iMi digital](https://www.imi-digital.de/) |
55 |
| -- [Earthlink](https://www.earthlink.ro/) |
56 |
| -- [Steadfast Collective](https://steadfastcollective.com/) |
57 |
| -- [We Are The Robots Inc.](https://watr.mx/) |
58 |
| -- [Understand.io](https://www.understand.io/) |
59 |
| -- [Abdel Elrafa](https://abdelelrafa.com) |
60 |
| -- [Hyper Host](https://hyper.host) |
61 |
| -- [Appoly](https://www.appoly.co.uk) |
62 |
| -- [OP.GG](https://op.gg) |
| 1 | +## Laravel-Portugal API |
| 2 | + |
| 3 | +[](https://travis-ci.org/laravel-portugal/api) |
| 4 | +[](https://coveralls.io/github/laravel-portugal/api?branch=master) |
| 5 | + |
| 6 | +## Installation |
| 7 | + |
| 8 | +**Requirements** |
| 9 | + |
| 10 | +- PHP >= 7.4 |
| 11 | +- MySQL >= 8, MariaDB >= 10 or PostgreSQL >= 11 |
| 12 | + |
| 13 | +**Steps to activate this project** |
| 14 | + |
| 15 | +1. Clone this repository. |
| 16 | +2. Run `composer install` to install all dependencies (add `--no-dev` if you're using this in production). |
| 17 | +3. Run `cp .env.example .env` to create an `.env` file based on the distributed `.env.example` file. |
| 18 | +4. Run `php artisan key:generate` to generate a new application key. |
| 19 | +5. Update the `.env` file with the connection details for the database. |
| 20 | +6. Run `php artisan migrate` to create the database schema. |
| 21 | + |
| 22 | +## Testing |
| 23 | + |
| 24 | +This project is fully tested. We have an [automatic pipeline](https://travis-ci.org/laravel-portugal/api) and an [automatic code quality analysis](https://coveralls.io/github/laravel-portugal/api) tool set up to continuously test and assert the quality of all code published in this repository, but you can execute the test suite yourself by running the following command: |
| 25 | + |
| 26 | +``` bash |
| 27 | +vendor/bin/phpunit |
| 28 | +``` |
| 29 | + |
| 30 | +_Note: This assumes you've run `composer install` (without the `--no-dev` option)._ |
| 31 | + |
| 32 | +**We aim to keep the master branch always deployable.** Exceptions may happen, but they should be extremely rare. |
| 33 | + |
| 34 | +## Changelog |
| 35 | + |
| 36 | +Please see [CHANGELOG](changelog.md) for more information on what has changed recently. |
63 | 37 |
|
64 | 38 | ## Contributing
|
65 | 39 |
|
66 |
| -Thank you for considering contributing to the Laravel framework! The contribution guide can be found in the [Laravel documentation](https://laravel.com/docs/contributions). |
| 40 | +Please see [CONTRIBUTING](contributing.md) for details. |
67 | 41 |
|
68 |
| -## Code of Conduct |
| 42 | +### Security |
69 | 43 |
|
70 |
| -In order to ensure that the Laravel community is welcoming to all, please review and abide by the [Code of Conduct](https://laravel.com/docs/contributions#code-of-conduct). |
| 44 | +If you discover any security related issues, please [talk to us on Discord](https://laravel.pt) instead of using the issue tracker. |
71 | 45 |
|
72 |
| -## Security Vulnerabilities |
| 46 | +## Credits |
73 | 47 |
|
74 |
| -If you discover a security vulnerability within Laravel, please send an e-mail to Taylor Otwell via [[email protected]](mailto:[email protected]). All security vulnerabilities will be promptly addressed. |
| 48 | +- [José Postiga](https://github.com/josepostiga) |
| 49 | +- [All Contributors](../../contributors) |
75 | 50 |
|
76 | 51 | ## License
|
77 | 52 |
|
78 |
| -The Laravel framework is open-sourced software licensed under the [MIT license](https://opensource.org/licenses/MIT). |
| 53 | +The MIT License (MIT). Please see [License File](license.md) for more information. |
0 commit comments