Add README and install instructions

This commit is contained in:
2020-04-17 12:21:09 +02:00
parent 8a0b9bf776
commit 524ffcd02c
2 changed files with 59 additions and 100 deletions

View File

@@ -1,46 +1,7 @@
APP_NAME=Laravel
APP_NAME=JurassicLand
APP_ENV=local
APP_KEY=
APP_DEBUG=true
APP_URL=http://localhost
LOG_CHANNEL=stack
DB_CONNECTION=mysql
DB_HOST=127.0.0.1
DB_PORT=3306
DB_DATABASE=laravel
DB_USERNAME=root
DB_PASSWORD=
BROADCAST_DRIVER=log
CACHE_DRIVER=file
QUEUE_CONNECTION=sync
SESSION_DRIVER=file
SESSION_LIFETIME=120
REDIS_HOST=127.0.0.1
REDIS_PASSWORD=null
REDIS_PORT=6379
MAIL_MAILER=smtp
MAIL_HOST=smtp.mailtrap.io
MAIL_PORT=2525
MAIL_USERNAME=null
MAIL_PASSWORD=null
MAIL_ENCRYPTION=null
MAIL_FROM_ADDRESS=null
MAIL_FROM_NAME="${APP_NAME}"
AWS_ACCESS_KEY_ID=
AWS_SECRET_ACCESS_KEY=
AWS_DEFAULT_REGION=us-east-1
AWS_BUCKET=
PUSHER_APP_ID=
PUSHER_APP_KEY=
PUSHER_APP_SECRET=
PUSHER_APP_CLUSTER=mt1
MIX_PUSHER_APP_KEY="${PUSHER_APP_KEY}"
MIX_PUSHER_APP_CLUSTER="${PUSHER_APP_CLUSTER}"

118
README.md
View File

@@ -1,79 +1,77 @@
<p align="center"><img src="https://res.cloudinary.com/dtfbvvkyp/image/upload/v1566331377/laravel-logolockup-cmyk-red.svg" width="400"></p>
# Jurassic Land
<p align="center">
<a href="https://travis-ci.org/laravel/framework"><img src="https://travis-ci.org/laravel/framework.svg" alt="Build Status"></a>
<a href="https://packagist.org/packages/laravel/framework"><img src="https://poser.pugx.org/laravel/framework/d/total.svg" alt="Total Downloads"></a>
<a href="https://packagist.org/packages/laravel/framework"><img src="https://poser.pugx.org/laravel/framework/v/stable.svg" alt="Latest Stable Version"></a>
<a href="https://packagist.org/packages/laravel/framework"><img src="https://poser.pugx.org/laravel/framework/license.svg" alt="License"></a>
</p>
Test technique pour B-Appli.
## About Laravel
Réalisé en utilisant le framework PHP Laravel. Testé avec une base SQLite.
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:
## Compte-rendu
- [Simple, fast routing engine](https://laravel.com/docs/routing).
- [Powerful dependency injection container](https://laravel.com/docs/container).
- Multiple back-ends for [session](https://laravel.com/docs/session) and [cache](https://laravel.com/docs/cache) storage.
- Expressive, intuitive [database ORM](https://laravel.com/docs/eloquent).
- Database agnostic [schema migrations](https://laravel.com/docs/migrations).
- [Robust background job processing](https://laravel.com/docs/queues).
- [Real-time event broadcasting](https://laravel.com/docs/broadcasting).
Fonctionnalités :
[X] Création d'un enclos
[X] Modification du nom d'un enclos
[X] Modification de l'état d'un enclos
[X] Enregistrement des changements d'état des enclos (ouvertures et fermetures)
[X] Listing des enclos avec leurs status
[X] Suppression d'un enclos
[ ] Listing des ouvertures/fermetures
[ ] Styler les pages correctement (css, bootstrap)
[ ] Gérer les erreurs de validation de façon user-friendly (reporter l'erreur dans l'interface, catcher les exceptions)
[ ] Ajout d'une ouverture aléatoire pour modéliser l'ouverture par les vélociraptors
[ ] Brancher le système d'authentification de Laravel
Laravel is accessible, powerful, and provides tools required for large, robust applications.
## Learning Laravel
## Remarques
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.
Codé en environ 2h30. C'était pour moi l'occasion de découvrir Laravel.
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.
## Laravel Sponsors
L'implémentation utilise au maximum les facilités offertes par Laravel : ORM,
migrations de base de données, routage d'un modèle.
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).
La modélisation est très simple :
- un modèle Paddock (`app/Paddock.php`), qui modélise un enclos : id, nom, état
(booléen isClosed) ;
- un modèle PaddockStateChange (`app/PaddockStateChange.php`), qui modélise un
changement d'état (ouverture/fermeture). On utilise le fait que l'ORM de
laravel stocke automatiquement des timestamps de création et mise à jour pour
stocker la date d'ouverture/fermeture de l'enclos ;
- Paddock et PaddockStateChange sont liés par une relation hasMany ;
- le controlleur PaddockController (`app/Http/Controller/PaddockController.php`)
est dérivé du squelette créé automatiquement par Laravel ;
- ce qui permet de router toutes les actions CRUD classiques en une ligne dans
`routes/web.php` ;
- les fichiers de migration sont dans `database/migrations`
(create_paddock_table, add_unique_constraint_on_paddock_names,
create_paddock_state_changes).
- **[Vehikl](https://vehikl.com/)**
- **[Tighten Co.](https://tighten.co)**
- **[Kirschbaum Development Group](https://kirschbaumdevelopment.com)**
- **[64 Robots](https://64robots.com)**
- **[Cubet Techno Labs](https://cubettech.com)**
- **[Cyber-Duck](https://cyber-duck.co.uk)**
- **[British Software Development](https://www.britishsoftware.co)**
- **[Webdock, Fast VPS Hosting](https://www.webdock.io/en)**
- **[DevSquad](https://devsquad.com)**
- [UserInsights](https://userinsights.com)
- [Fragrantica](https://www.fragrantica.com)
- [SOFTonSOFA](https://softonsofa.com/)
- [User10](https://user10.com)
- [Soumettre.fr](https://soumettre.fr/)
- [CodeBrisk](https://codebrisk.com)
- [1Forge](https://1forge.com)
- [TECPRESSO](https://tecpresso.co.jp/)
- [Runtime Converter](http://runtimeconverter.com/)
- [WebL'Agence](https://weblagence.com/)
- [Invoice Ninja](https://www.invoiceninja.com)
- [iMi digital](https://www.imi-digital.de/)
- [Earthlink](https://www.earthlink.ro/)
- [Steadfast Collective](https://steadfastcollective.com/)
- [We Are The Robots Inc.](https://watr.mx/)
- [Understand.io](https://www.understand.io/)
- [Abdel Elrafa](https://abdelelrafa.com)
- [Hyper Host](https://hyper.host)
- [Appoly](https://www.appoly.co.uk)
- [OP.GG](https://op.gg)
- [云软科技](http://www.yunruan.ltd/)
## Contributing
Propriétés :
* un enclos est identifié de manière unique par son nom : assuré par une
contrainte d'intégrité sur la colonne de la base de données.
* enclos fermé par défaut (valeur par défaut dans le modèle)
Thank you for considering contributing to the Laravel framework! The contribution guide can be found in the [Laravel documentation](https://laravel.com/docs/contributions).
## Code of Conduct
## Installation et test
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).
## Security Vulnerabilities
Pré-requis : installation de Laravel
If you discover a security vulnerability within Laravel, please send an e-mail to Taylor Otwell via [taylor@laravel.com](mailto:taylor@laravel.com). All security vulnerabilities will be promptly addressed.
```
composer global require laravel/installer
```
## License
The Laravel framework is open-sourced software licensed under the [MIT license](https://opensource.org/licenses/MIT).
Clonage et mise en route :
```
git clone http://git.dromaludaire.info/benjamin/bappli-jurassic-land.git
cd bappli-jurassic-land
composer update
cp .env.example .env
php artisan key:generate
touch database/database.sqlite
php artisan migrate
php artisan serve
```
Et l'application est ensuite disponible sur <http://localhost:8000>