Skip to content

Commit 09269bd

Browse files
committed
📜 README update
1 parent 1ed039e commit 09269bd

File tree

1 file changed

+41
-48
lines changed

1 file changed

+41
-48
lines changed

README.md

Lines changed: 41 additions & 48 deletions
Original file line numberDiff line numberDiff line change
@@ -1,66 +1,59 @@
1-
<p align="center"><a href="https://laravel.com" target="_blank"><img src="https://raw.githubusercontent.com/laravel/art/master/logo-lockup/5%20SVG/2%20CMYK/1%20Full%20Color/laravel-logolockup-cmyk-red.svg" width="400" alt="Laravel Logo"></a></p>
1+
<p align="center"><a href="https://babyiut.fr" target="_blank"><img src="https://i.ibb.co/kqf5tL6/Mockup.png" width="400" alt="IUTBabyFoot Mockup"></a></p>
22

33
<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://img.shields.io/packagist/dt/laravel/framework" alt="Total Downloads"></a>
6-
<a href="https://packagist.org/packages/laravel/framework"><img src="https://img.shields.io/packagist/v/laravel/framework" alt="Latest Stable Version"></a>
7-
<a href="https://packagist.org/packages/laravel/framework"><img src="https://img.shields.io/packagist/l/laravel/framework" alt="License"></a>
4+
<a href="https://GitHub.com/FragDev/IUTBabyFoot/commit/">
5+
<img src="https://badgen.net/github/commits/FragDev/IUTBabyFoot" alt="GitHub commits">
6+
</a>
7+
<a href="https://GitHub.com/FragDev/IUTBabyFoot/issues/">
8+
<img src="https://badgen.net/github/issues/FragDev/IUTBabyFoot/" alt="GitHub issues">
9+
</a>
10+
<a href="https://GitHub.com/FragDev/IUTBabyFoot/graphs/contributors/">
11+
<img src="https://badgen.net/github/contributors/FragDev/IUTBabyFoot" alt="GitHub contributors">
12+
</a>
813
</p>
914

10-
## About Laravel
15+
## About IUTBabyFoot
1116

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:
17+
IUTBabyFoot is a web application, under Laravel framework, whose goal is to collect statistics of table soccer matches.
1318

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).
19+
## Features
2120

22-
Laravel is accessible, powerful, and provides tools required for large, robust applications.
21+
- Live matches
22+
- Adding matches
23+
- Betting system
24+
- Player ranking
25+
- Advanced statistics
26+
- Connection with Discord
2327

24-
## Learning Laravel
28+
IUTBabyFoot is designed to be used on a smartphone but works completely on any other device.
2529

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.
30+
## Installation
2731

28-
You may also try the [Laravel Bootcamp](https://bootcamp.laravel.com), where you will be guided through building a modern Laravel application from scratch.
32+
### Requirements
2933

30-
If you don't feel like reading, [Laracasts](https://laracasts.com) can help. Laracasts contains over 2000 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.
34+
- PHP >= 8.0
35+
- MySQL
36+
- Composer
37+
- NodeJS
38+
- NPM
39+
- Laravel 9.X requirements
3140

32-
## Laravel Sponsors
41+
### Installation
3342

34-
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).
43+
1. Clone the repository
44+
2. Install dependencies with `composer install`
45+
3. Install dependencies with `npm install`
46+
4. Create a `.env` file with `cp .env.example .env`
47+
5. Generate an application key with `php artisan key:generate`
48+
6. Create a database and configure the `.env` file
49+
7. Run the migrations with `php artisan migrate`
50+
8. Run the server with `php artisan serve`
51+
9. Run the vite server with `npm run dev`
3552

36-
### Premium Partners
53+
### Build
3754

38-
- **[Vehikl](https://vehikl.com/)**
39-
- **[Tighten Co.](https://tighten.co)**
40-
- **[Kirschbaum Development Group](https://kirschbaumdevelopment.com)**
41-
- **[64 Robots](https://64robots.com)**
42-
- **[Cubet Techno Labs](https://cubettech.com)**
43-
- **[Cyber-Duck](https://cyber-duck.co.uk)**
44-
- **[Many](https://www.many.co.uk)**
45-
- **[Webdock, Fast VPS Hosting](https://www.webdock.io/en)**
46-
- **[DevSquad](https://devsquad.com)**
47-
- **[Curotec](https://www.curotec.com/services/technologies/laravel/)**
48-
- **[OP.GG](https://op.gg)**
49-
- **[WebReinvent](https://webreinvent.com/?utm_source=laravel&utm_medium=github&utm_campaign=patreon-sponsors)**
50-
- **[Lendio](https://lendio.com)**
51-
52-
## Contributing
53-
54-
Thank you for considering contributing to the Laravel framework! The contribution guide can be found in the [Laravel documentation](https://laravel.com/docs/contributions).
55-
56-
## Code of Conduct
57-
58-
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).
59-
60-
## Security Vulnerabilities
61-
62-
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.
55+
To build the application, run `npm run build`.
6356

6457
## License
6558

66-
The Laravel framework is open-sourced software licensed under the [MIT license](https://opensource.org/licenses/MIT).
59+
IUTBabyFoot is open-sourced software licensed under the [MIT license](https://opensource.org/licenses/MIT).

0 commit comments

Comments
 (0)