Skip to content

Commit ed3208e

Browse files
authored
docs: [LAR-147] update readme (#272)
1 parent a1b0742 commit ed3208e

File tree

6 files changed

+60
-40
lines changed

6 files changed

+60
-40
lines changed

README.md

Lines changed: 42 additions & 20 deletions
Original file line numberDiff line numberDiff line change
@@ -1,66 +1,80 @@
11
<p align="center">
2-
<img src="./art/logo.svg" height="250" />
2+
<img src="./art/logo.svg" height="250" alt="Community logo" />
33
</p>
44

55
<p align="center">
66
<a href="https://laravel.com">
7-
<img alt="Laravel v10.x" src="https://img.shields.io/badge/Laravel-v10.x-FF2D20">
7+
<img alt="Laravel v11.x" src="https://img.shields.io/badge/Laravel-v11.x-FF2D20">
88
</a>
99
<a href="https://github.com/laravelcm/laravel.cm/actions">
1010
<img src="https://github.com/laravelcm/laravel.cm/workflows/Tests/badge.svg" alt="Build Status" />
1111
</a>
12-
<a href="https://github.com/laravelcm/laravel.cm/actions/workflows/coding-standards.yml">
13-
<img src="https://github.com/laravelcm/laravel.cm/actions/workflows/coding-standards.yml/badge.svg" alt="Coding Standards" />
12+
<a href="https://github.com/laravelcm/laravel.cm/actions/workflows/quality.yml">
13+
<img src="https://github.com/laravelcm/laravel.cm/actions/workflows/quality.yml/badge.svg" alt="Coding Standards" />
1414
</a>
1515
<a href="https://forge.laravel.com">
1616
<img src="https://img.shields.io/endpoint?url=https%3A%2F%2Fforge.laravel.com%2Fsite-badges%2Fb0b9e269-e85c-40eb-9b8d-cfa8197a1bb2&style=plastic" alt="Laravel Forge Site Deployment Status" />
1717
</a>
1818
</p>
1919

2020
## Laravel.cm
21+
2122
Ce dépôt contient le code source du site de [Laravel.cm](https://laravel.cm). Laravel Cameroun est la plus grande communauté de
2223
développeurs PHP & Laravel résidant au Cameroun.
2324

2425
## Rejoindre la communauté
26+
2527
Vous pouvez rejoindre la communauté ou nous suivre via nos différentes plateformes
2628

27-
[Site Officiel](https://laravel.cm) - [Facebook](https://www.facebook.com/laravelcm) - [Twitter](https://twitter.com/laravelcm) - [Rejoindre Slack](https://laravel.cm/slack) - [Rejoindre Discord](https://laravel.cm/discord)
29+
- [Discord](https://discord.gg/KNp6brbyVD)
30+
- [Telegram](https://t.me/laravelcameroun)
31+
- [Twitter](https://twitter.com/laravelcm)
32+
- [Facebook](https://www.facebook.com/laravelcm)
2833

2934
## Sponsors
35+
3036
Nous tenons à remercier ces **entreprises extraordinaires** pour leur parrainage. Si vous souhaitez devenir sponsor, veuillez visiter <a href="https://laravel.cm/sponsors">la page Laravel.cm de Sponsoring</a>.
3137

3238
- **[Laravel Shopper](https://laravelshopper.dev)**
3339
- [GDG Douala](https://gdg.community.dev/gdg-douala)
34-
- [NotchPay](https://notchpay.co)
35-
- [Sharuco](https://sharuco.lndev.me)
40+
- [NotchPay](https://notchpay.co?utm_source=laravel.cm)
41+
- [LN UI](https://ui.lndev.me?utm_source=laravel.cm)
3642

3743
## Caractéristiques Serveur
38-
The following tools are required in order to start the installation.
3944

40-
- PHP >=8.0
45+
Les dépendances suivantes sont nécessaires pour démarrer l'installation.
46+
47+
- PHP >= 8.2
4148
- [Composer](https://getcomposer.org/download/)
4249
- [Yarn](https://yarnpkg.com/getting-started/install)
43-
- [Valet](https://laravel.com/docs/valet#installation)
50+
- [Valet](https://laravel.com/docs/valet#installation) or [Herd](https://herd.laravel.com)
4451

4552
## Installation
46-
> Notez que vous êtes libre d'ajuster l'emplacement `~/Sites/laravel.cm` à n'importe quel répertoire de votre choix sur votre machine. Ce faisant, assurez-vous d'exécuter la commande `valet link` dans le répertoire souhaité.
53+
54+
> Notez que vous êtes libre d'ajuster l'emplacement `~/Sites/laravel.cm` à n'importe quel répertoire de votre choix sur votre machine. Ce faisant, assurez-vous d'exécuter la commande `valet link` (si vous utilisez Laravel Valet) dans le répertoire souhaité.
4755
4856
1. Clonez ce repo avec la commande `git clone git@github.com:laravelcm/laravel.cm.git ~/Sites/laravel.cm`
4957
2. Exécuter `composer install` pour installer les dépendances PHP
50-
3. Configurez une base de données locale appelée `laravelcm`
58+
3. Configurez une base de données locale (vous pouvez l'appeler `laravelcm`)
5159
4. Exécutez `composer setup` pour configurer l'application
5260
5. Configurer un pilote de messagerie fonctionnel comme [Mailtrap](https://mailtrap.io/) ou [Maildev](https://maildev.github.io/maildev/)
5361
6. Configurez les fonctionnalités (facultatives) ci-dessous
5462

55-
Vous pouvez maintenant visiter l'application dans votre navigateur en visitant [http://laravel.cm.test](http://laravel.cm.test). Si vous avez amorcé la base de données, vous pouvez vous connecter à un compte de test avec ** `johndoe` ** & **` password` **.
63+
Vous pouvez maintenant visiter l'application dans votre navigateur en visitant [http://laravel.cm.test](http://laravel.cm.test).
64+
Si vous avez amorcé la base de données, vous pouvez vous connecter à un compte de test avec ** `johndoe` ** & **` password` **.
65+
66+
Une fois que vous avez installé et configuré, pour avoir des dummy data, vous devez exécuter la commande :
5667

57-
Une fois que vous avez installé et configuré, pour avoir des dummy data, vous devez exécuter la commande
5868
```shell
5969
php artisan db:seed --class=DummyDatabaseSeeder
6070
```
6171

6272
### GitHub Authentication (optionnel)
63-
Pour que l'authentification Github fonctionne localement, vous devez [enregistrer une nouvelle application OAuth sur Github](https://github.com/settings/applications/new). Utilisez `http://laravel.cm.test` pour l'URL de la page d'accueil et `http://laravel.cm.test/auth/github` pour l'URL de rappel. Lorsque vous avez créé l'application, remplissez l'ID et le secret dans votre fichier `.env` dans les variables d'environnement ci-dessous. Vous devriez maintenant pouvoir vous authentifier avec Github.
73+
74+
Pour que l'authentification Github fonctionne localement, vous devez [enregistrer une nouvelle application OAuth sur Github](https://github.com/settings/applications/new).
75+
Utilisez `http://laravel.cm.test` pour l'URL de la page d'accueil et `http://laravel.cm.test/auth/github` pour l'URL de rappel.
76+
Lorsque vous avez créé l'application, remplissez l'ID et le secret dans votre fichier `.env` dans les variables d'environnement ci-dessous.
77+
Vous devriez maintenant pouvoir vous authentifier avec Github.
6478

6579
```shell
6680
GITHUB_ID=
@@ -69,7 +83,10 @@ GITHUB_URL=http://laravel.cm.test/auth/github
6983
```
7084

7185
### Twitter Sharing (optionnel)
72-
Pour permettre le partage automatique des articles publiés sur Twitter, vous devez [créer une application Twitter](https://developer.twitter.com/apps/). Une fois l'application créée, mettez à jour les variables ci-dessous dans votre fichier `.env`. La clé et le secret du consommateur ainsi que le jeton et le secret d'accès se trouvent dans la section «Clés et jetons» de l'interface utilisateur des développeurs Twitter.
86+
87+
Pour permettre le partage automatique des articles publiés sur Twitter, vous devez [créer une application Twitter](https://developer.twitter.com/apps/).
88+
Une fois l'application créée, mettez à jour les variables ci-dessous dans votre fichier `.env`.
89+
La clé et le secret du consommateur ainsi que le jeton et le secret d'accès se trouvent dans la section « Clés et jetons » de l'interface utilisateur des développeurs Twitter.
7390

7491
```shell
7592
TWITTER_CONSUMER_KEY=
@@ -78,10 +95,13 @@ TWITTER_ACCESS_TOKEN=
7895
TWITTER_ACCESS_SECRET=
7996
```
8097

81-
Les articles approuvés sont partagés dans l'ordre dans lequel ils ont été soumis pour approbation. Les articles sont partagés deux fois par jour à 14h00 et 18h00 UTC. Une fois qu'un article a été partagé, il ne sera plus partagé.
98+
Les articles approuvés sont partagés dans l'ordre dans lequel ils ont été soumis pour approbation. Les articles sont partagés deux fois par jour à 14h00 et 18h00 UTC.
99+
Une fois qu'un article a été partagé, il ne sera plus partagé.
82100

83101
### Notifications Telegram (optionnel)
84-
Laravel Cameroun peut notifier les administrateurs des nouveaux articles soumis via Telegram. Pour que cela fonctionne, vous devez configurer un [bot Telegram](https://core.telegram.org/bots) et obtenir un token. Ensuite, configurez le canal sur lequel vous souhaitez envoyer les messages relatifs aux nouveaux articles.
102+
103+
Laravel Cameroun peut notifier les administrateurs des nouveaux articles soumis via Telegram. Pour que cela fonctionne, vous devez configurer un [bot Telegram](https://core.telegram.org/bots) et obtenir un token.
104+
Ensuite, configurez le canal sur lequel vous souhaitez envoyer les messages relatifs aux nouveaux articles.
85105

86106
```shell
87107
TELEGRAM_BOT_TOKEN=
@@ -91,9 +111,11 @@ TELEGRAM_CHANNEL=
91111
## Commands
92112
| Command | Description |
93113
|------------------------------------|--------------------------------------------------------|
94-
| **`composer test`** | Exécuter les tests |
114+
| **`composer lint`** | Appliquer le formatage de code avec `laravel/pint` |
115+
| **`composer test:phpstan`** | Appliquer l'analyse statique avec phpstan |
116+
| **`composer test:pest`** | Exécuter les tests |
95117
| `php artisan migrate:fresh --seed` | Reset la base de données |
96-
| `yarn && yarn watch` | Surveillez les changements dans les fichiers CSS et JS |
118+
| `yarn && yarn dev` | Surveillez les changements dans les fichiers CSS et JS |
97119

98120
## Maintainers
99121

app/Http/Controllers/NotchPayCallBackController.php

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -11,7 +11,6 @@
1111
use Illuminate\Http\Request;
1212
use Illuminate\Support\Facades\Cache;
1313
use Illuminate\Support\Facades\Log;
14-
use NotchPay\Exceptions\ApiException;
1514
use NotchPay\NotchPay;
1615
use NotchPay\Payment;
1716

@@ -39,7 +38,7 @@ public function __invoke(Request $request): RedirectResponse
3938
value: __('Votre paiement a été annulé veuillez relancer pour soutenir Laravel Cameroun, Merci.')
4039
);
4140
} else {
42-
// @ToDO Envoie de mail de notification de remerciement pour le sponsoring si l'utilisateur est dans la base de données
41+
// @ToDO: Envoie de mail de notification de remerciement pour le sponsoring si l'utilisateur est dans la base de données
4342
event(new SponsoringPaymentInitialize($transaction));
4443

4544
Cache::forget(key: 'sponsors');
@@ -50,8 +49,9 @@ public function __invoke(Request $request): RedirectResponse
5049
);
5150
}
5251

53-
} catch (ApiException $e) {
52+
} catch (\Exception $e) {
5453
Log::error($e->getMessage());
54+
5555
session()->flash(
5656
key: 'error',
5757
value: __('Une erreur s\'est produite lors de votre paiement. Veuillez relancer Merci.')

database/seeders/Fixtures/ArticleTableSeeder.php

Lines changed: 6 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -7,7 +7,6 @@
77
use App\Models\Article;
88
use App\Models\Tag;
99
use App\Models\User;
10-
use Faker\Generator as Faker;
1110
use Illuminate\Database\Console\Seeds\WithoutModelEvents;
1211
use Illuminate\Database\Seeder;
1312

@@ -22,10 +21,9 @@ public function run(): void
2221
->whereJsonContains('concerns', ['post'])
2322
->get()
2423
->modelKeys();
25-
$faker = new Faker;
2624

2725
/** @var Article $article1 */
28-
$article1 = Article::create([
26+
$article1 = Article::query()->create([
2927
'title' => $name = 'Voyager - The Missing Laravel Admin',
3028
'slug' => $name,
3129
'body' => "
@@ -132,7 +130,7 @@ public function run(): void
132130
->toMediaCollection('media');
133131

134132
/** @var Article $article2 */
135-
$article2 = Article::create([
133+
$article2 = Article::query()->create([
136134
'title' => $name = 'Awesome of awesome',
137135
'slug' => $name,
138136
'body' => "
@@ -399,7 +397,7 @@ public function run(): void
399397
->toMediaCollection('media');
400398

401399
/** @var Article $article3 */
402-
$article3 = Article::create([
400+
$article3 = Article::query()->create([
403401
'title' => $name = 'React Email Editor',
404402
'slug' => $name,
405403
'body' => "
@@ -522,7 +520,7 @@ public function run(): void
522520
->toMediaCollection('media');
523521

524522
/** @var Article $article4 */
525-
$article4 = Article::create([
523+
$article4 = Article::query()->create([
526524
'title' => $name = 'Awesome Laravel Package, Tutorials, News',
527525
'slug' => $name,
528526
'body' => "
@@ -1106,7 +1104,7 @@ public function run(): void
11061104
->toMediaCollection('media');
11071105

11081106
/** @var Article $article5 */
1109-
$article5 = Article::create([
1107+
$article5 = Article::query()->create([
11101108
'title' => $name = 'COVID TEST CENTER',
11111109
'slug' => $name,
11121110
'body' => "
@@ -1180,7 +1178,7 @@ public function run(): void
11801178
->toMediaCollection('media');
11811179

11821180
/** @var Article $article6 */
1183-
$article6 = Article::create([
1181+
$article6 = Article::query()->create([
11841182
'title' => $name = 'Le nouveau site de Grafikart (Grafikart.New)',
11851183
'slug' => $name,
11861184
'body' => "

database/seeders/Fixtures/ThreadTableSeeder.php

Lines changed: 5 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -21,14 +21,12 @@ public function run(): void
2121
->get()
2222
->modelKeys();
2323

24-
Thread::factory(['user_id' => random_int(1, count($usersIds))])
24+
Thread::factory(['user_id' => array_rand($usersIds)])
2525
->count(40)
26+
->has(
27+
Reply::factory(['user_id' => array_rand($usersIds)])->count(5),
28+
'replies'
29+
)
2630
->create();
27-
28-
/*$threadsIds = Thread::query()->inRandomOrder()
29-
->get()
30-
->modelKeys();
31-
32-
Reply::factory(['user_id' => random_int(1, count($threadsIds))])->create();*/
3331
}
3432
}

resources/views/ads/ln.blade.php

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -25,7 +25,7 @@ class="absolute left-1/2 top-0 ml-[-19rem] w-[69.5625rem] fill-white blur-[26px]
2525
<path d="M.016 439.5s-9.5-300 434-300S882.516 20 882.516 20V0h230.004v439.5H.016Z" />
2626
</svg>
2727
</div>
28-
<a href="https://ui.lndev.me/?utm_source=laravel.cm" target="_blank">
28+
<a href="https://ui.lndev.me?utm_source=laravel.cm" target="_blank">
2929
<svg viewBox="0 0 104 24" xmlns="http://www.w3.org/2000/svg" class="h-6" aria-hidden="true">
3030
<rect width="24" height="24" rx="6" class="fill-[#060911] dark:fill-white" />
3131
<path

resources/views/livewire/pages/home.blade.php

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -235,5 +235,7 @@ class="absolute inset-x-0 top-0 h-32 bg-gradient-to-b from-black xl:inset-y-0 xl
235235
</div>
236236
</div>
237237

238-
<livewire:components.github-repositories />
238+
@if(config('services.github.token'))
239+
<livewire:components.github-repositories />
240+
@endif
239241
</div>

0 commit comments

Comments
 (0)