Develop (#407)

* chore: update local development readme and db seeder (#404)

* chore: update development readme

* chore: add about and faq pages to db seeder

* chore: readme tiny change

* hotfix: filter out projects with invalid dates (#406)

* fix: apply HasValidDates scope to Project and BCRProject queries

* chore: rename for readability

fix

Author: ancarofl

.env.example

@@ -1,4 +1,4 @@
-APP_NAME=Bursa binelui
+APP_NAME="Bursa binelui"
 APP_ENV=local
 APP_KEY=
 APP_DEBUG=true
@@ -14,7 +14,7 @@ DB_CONNECTION=mysql
 DB_HOST=mariadb
 DB_PORT=3306
 DB_DATABASE=bursa_binelui
-DB_USERNAME=bursa_binelui
+DB_USERNAME=
 DB_PASSWORD=
 
 BROADCAST_DRIVER=log

README.md

@@ -36,6 +36,63 @@ If you would like to suggest new functionality, open an Issue and mark it as a _
 
 Mention all related repos and projects.
 
+## Development
+
+### Running the app
+- After initial setup (below), run `npm run dev`
+- If using Laravel Herd/Valet, access your app in the browser at `https://bursabinelui.test`
+- If using the built-in PHP server:
+	- run `php artisan:serve`
+	- access your app in the browser at `http://127.0.0.1:8000`
+
+### Initial setup
+<details>
+<summary>See initial setup</strong></summary>
+
+#### 1. Create local database `bursa_binelui`
+
+#### 2. Copy `.env.example`, rename it to `.env` and fill in your database information
+
+#### 3. Install composer dependencies
+```bash
+composer install
+```
+
+#### 4. Install npm dependencies
+```bash
+npm install
+```
+
+#### 5. Generate the app secret key
+```bash
+php artisan key:generate
+```
+
+#### 6. Migrate and seed the database
+```bash
+php artisan migrate:fresh --seed
+```
+> **Note:** Seeding may fail due to underlying issues with Faker date generation. If that happens, just rerun `php artisan migrate:fresh --seed`. Also, seeding can take a while, so be patient.
+
+#### 7. Add the following line to your `.env` file to disable CSP locally
+```bash
+CSP_ENABLED=false
+```
+
+> **Note:** Only for local development!
+
+#### 8. Configure local development URL
+#### 8.1. If using Laravel Herd (macOS, Windows)
+- **Install Laravel Herd**  
+   Visit [https://herd.laravel.com](https://herd.laravel.com) and download the installer for macOS or Windows
+- **Open your project with Herd**  
+  - Launch Herd. Go to `Sites`. Go to `Add Sites`. Go to `Link existing project`. Select the project. Select the `PHP version` and `enable HTTPS`. Click `Next`
+  - ![](https://i.imgur.com/YYhxeVK.png)
+
+#### 8.2. If using the built-in PHP server
+- In your `.env` file, update `APP_URL` to `APP_URL=http://127.0.0.1:8000`
+</details>
+
 ## Deployment
 
 Guide users through getting your code up and running on their own system. In this section you can talk about:

app/Http/Controllers/HomeController.php

@@ -29,6 +29,7 @@ public function index()
 
             'projects' => ProjectCardResource::collection(
                 Project::whereIsOpen()
+                    ->whereHasValidDates('start','end')
                     ->latest()
                     ->limit(12)
                     ->get()
@@ -37,6 +38,7 @@ public function index()
             'bcr_projects' => BCRProjectCardResource::collection(
                 BCRProject::query()
                     ->where('status', ProjectStatus::approved)
+                    ->whereHasValidDates()
                     ->latest()
                     ->with('county')
                     ->limit(12)

app/Http/Controllers/ProjectController.php

@@ -62,7 +62,8 @@ protected function projectList(Request $request, string $view): Response
                 AllowedSort::custom('donations_count', new ProjectDonationsCountSort),
             ])
             ->defaultSort('-id')
-            ->whereIsPublished();
+            ->whereIsPublished()
+            ->whereHasValidDates('start', 'end');
 
         return Inertia::render('Public/Projects/Index', [
             'view' => $view,

app/Models/BCRProject.php

@@ -8,6 +8,7 @@
 use App\Concerns\HasSlug;
 use App\Enums\ProjectStatus;
 use App\Traits\HasProjectStatus;
+use App\Traits\HasValidDates;
 use Embed\Embed;
 use Illuminate\Database\Eloquent\Builder;
 use Illuminate\Database\Eloquent\Factories\HasFactory;
@@ -23,6 +24,7 @@ class BCRProject extends Model implements HasMedia
 {
     use HasFactory;
     use HasLocation;
+    use HasValidDates;
     use InteractsWithMedia;
     use HasProjectStatus;
     use HasSlug;
@@ -90,12 +92,12 @@ public function getEmbeddedVideosAttribute(): array
     {
         return collect($this->videos)
             ->pluck('link')
-            ->filter(fn ($video) => ! blank($video))
+            ->filter(fn($video) => ! blank($video))
             ->map(
-                fn (string $videoUrl) => Cache::remember(
+                fn(string $videoUrl) => Cache::remember(
                     'video-' . hash('sha256', $videoUrl),
                     MONTH_IN_SECONDS,
-                    fn () => rescue(fn () => (new Embed)->get($videoUrl)->code, '', false)
+                    fn() => rescue(fn() => (new Embed)->get($videoUrl)->code, '', false)
                 )
             )
             ->filter()

app/Models/Project.php

@@ -11,6 +11,7 @@
 use App\Enums\EuPlatescStatus;
 use App\Enums\ProjectStatus;
 use App\Traits\HasProjectStatus;
+use App\Traits\HasValidDates;
 use Embed\Embed;
 use Illuminate\Database\Eloquent\Builder;
 use Illuminate\Database\Eloquent\Factories\HasFactory;
@@ -39,6 +40,7 @@ class Project extends Model implements HasMedia
     use HasVolunteers;
     use InteractsWithMedia;
     use HasProjectStatus;
+    use HasValidDates;
     use HasSlug;
     use LogsActivity;
     use LogsActivityForApproval;
@@ -192,14 +194,14 @@ public function getIsDraftAttribute(): bool
 
     public function getIsPeriodActiveAttribute(): bool
     {
-        return $this->start->isPast() && $this->end->isFuture();
+        return $this->start?->isPast() && $this->end?->isFuture();
     }
 
     public function getIsActiveAttribute(): bool
     {
         return $this->status == ProjectStatus::approved
-            && $this->start->isPast()
-            && $this->end->isFuture();
+            && $this->start?->isPast()
+            && $this->end?->isFuture();
     }
 
     public function getCanBeArchivedAttribute(): bool
@@ -249,7 +251,7 @@ public function markAsApproved(): bool
             $slug .= '-' . ($count + 1);
         }
 
-        $this->activities->map(fn (Activity $activity) => $activity->approve());
+        $this->activities->map(fn(Activity $activity) => $activity->approve());
 
         return $this->update([
             'status' => ProjectStatus::approved,
@@ -280,10 +282,10 @@ public function getEmbeddedVideosAttribute(): array
             ->pluck('url')
             ->filter()
             ->map(
-                fn (string $videoUrl) => Cache::remember(
+                fn(string $videoUrl) => Cache::remember(
                     'video-' . hash('sha256', $videoUrl),
                     MONTH_IN_SECONDS,
-                    fn () => rescue(fn () => (new Embed)->get($videoUrl)->code, report: false)
+                    fn() => rescue(fn() => (new Embed)->get($videoUrl)->code, report: false)
                 )
             )
             ->filter()

app/Traits/HasValidDates.php

@@ -0,0 +1,16 @@
+<?php
+
+namespace App\Traits;
+
+use Illuminate\Database\Eloquent\Builder;
+
+trait HasValidDates
+{
+    public function scopeWhereHasValidDates(Builder $query, string $startColumn = 'start_date', string $endColumn = 'end_date'): Builder
+    {
+        return $query
+            ->whereNotNull($startColumn)
+            ->whereNotNull($endColumn)
+            ->whereColumn($startColumn, '<=', $endColumn);
+    }
+}

database/seeders/DatabaseSeeder.php

@@ -71,6 +71,8 @@ public function run(): void
 
         Page::factory()->count(10)->create();
 
+		$this->seedSpecificAboutAndFaqsPages();
+
         Edition::factory(['active' => true])
             ->count(1)
             ->create();
@@ -153,4 +155,35 @@ private function seedBadges(): void
                 ->create();
         }
     }
+
+	private function seedSpecificAboutAndFaqsPages(): void
+	{
+		// Add the /about page
+		Page::create([
+			'title' => ['ro' => 'Despre BB'],
+			'slug' => ['ro' => 'about'],
+			'description' => ['ro' => 'Răspunsuri la întrebările frecvente despre Bursa Binelui.'],
+			'content' => ['ro' => '<p>Bursa Binelui, singura platformă online de donații fără comision dedicată ONG-urilor din România, este un proiect creat și susținut de Banca Comercială Română (BCR) și coordonat în parteneriat Grupul PONT. Platforma aduce împreună organizațiile care au nevoie de sprijin pentru a-și desfășura activitatea și oamenii care vor să investească în faptele bune din comunitatea lor.</p>'],
+		]);
+
+		// Add the /faqs page
+		Page::create([
+			'title' => ['ro' => 'Întrebări frecvente'],
+			'slug' => ['ro' => 'faqs'],
+			'description' => ['ro' => 'Răspunsuri la întrebările frecvente despre Bursa Binelui.'],
+			'content' => ['ro' => '
+				<h2>Întrebări frecvente</h2>
+				<p>Aici găsiți răspunsuri la cele mai frecvente întrebări referitoare la Bursa Binelui.</p>
+				
+				<h3>1. Ce este Bursa Binelui?</h3>
+				<p>Bursa Binelui este o platformă dedicată strângerii de fonduri și voluntariatului pentru cauze sociale.</p>
+				
+				<h3>2. Cum pot dona?</h3>
+				<p>Puteți dona prin intermediul proiectelor disponibile pe platformă, folosind metoda de plată preferată.</p>
+				
+				<h3>3. Cum mă pot înscrie ca voluntar?</h3>
+				<p>Accesați pagina proiectului și folosiți formularul de înscriere voluntar pentru a vă oferi sprijinul.</p>
+    		'],
+		]);
+	}
 }