Docs/setup and troubleshooting guide

README.md

@@ -1,66 +1,21 @@
-<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>
+# Setup guide
 
-<p align="center">
-<a href="https://github.com/laravel/framework/actions"><img src="https://github.com/laravel/framework/workflows/tests/badge.svg" alt="Build Status"></a>
-<a href="https://packagist.org/packages/laravel/framework"><img src="https://img.shields.io/packagist/dt/laravel/framework" alt="Total Downloads"></a>
-<a href="https://packagist.org/packages/laravel/framework"><img src="https://img.shields.io/packagist/v/laravel/framework" alt="Latest Stable Version"></a>
-<a href="https://packagist.org/packages/laravel/framework"><img src="https://img.shields.io/packagist/l/laravel/framework" alt="License"></a>
-</p>
+## Running the project in development mode
 
-## About Laravel
+- Clone this repository by running `git clone https://github.com/NIAEFEUP/enei-website.git`.
+- Navigate to the newly created folder and copy the `env.example` file, renaming it `.env`.
+- Assuming you've already installed PHP, Composer and Node.js, simply run `./dev.sh` and access `localhost:8000`: the website should be available.
 
-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:
+## Troubleshooting
 
-- [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).
+### General tips
 
-Laravel is accessible, powerful, and provides tools required for large, robust applications.
+In case you come up with some unforeseen errors that you simply cannot find out how to solve, clearing the config cache and removing old volumes with `php artisan cache:clear` and `./sail down --rmi -v` respectively should help: the error might come from old cache or volumes.
 
-## Learning Laravel
+### "*Your requirements could not be resolved to an installable set of packages.*"
 
-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.
+This error might appear after `dev.sh` runs `composer update` when your device is missing a crucial PHP package. Look for a line like this:
 
-You may also try the [Laravel Bootcamp](https://bootcamp.laravel.com), where you will be guided through building a modern Laravel application from scratch.
+`- league/mime-type-detection[1.4.0, ..., 1.15.0] require ext-fileinfo * -> it is missing from your system. Install or enable PHP's fileinfo extension.`
 
-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.
-
-## Laravel Sponsors
-
-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).
-
-### Premium Partners
-
-- **[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)**
-- **[Many](https://www.many.co.uk)**
-- **[Webdock, Fast VPS Hosting](https://www.webdock.io/en)**
-- **[DevSquad](https://devsquad.com)**
-- **[Curotec](https://www.curotec.com/services/technologies/laravel/)**
-- **[OP.GG](https://op.gg)**
-- **[WebReinvent](https://webreinvent.com/?utm_source=laravel&utm_medium=github&utm_campaign=patreon-sponsors)**
-- **[Lendio](https://lendio.com)**
-
-## Contributing
-
-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
-
-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
-
-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.
-
-## License
-
-The Laravel framework is open-sourced software licensed under the [MIT license](https://opensource.org/licenses/MIT).
+The extension can be different, but in this case, you should install the `php8-fileinfo` package or enable it in your `php.ini` file (located at `/etc/php/<version>/cli/` or `/etc/php<version>/cli/`) by removing the semicolon in `;extension=fileinfo`, in case it is already installed.

dev.sh

@@ -1,15 +1,40 @@
 #!/bin/bash
 
-./sail up -d laravel.test
+# Peras: I have reworked this script to ensure future developers have a full, self-contained development environment by running it.
+# The includes:
+# - Checking for the existance of a '.env' file to hold environment variables needed for the first app bootstrap (building the images).
+# - 'sail up' command to start the Laravel Sail environment.
+# - Running the available migrations. The DB holds a special table to keep track of what has been migrated so they don't always run.
+# - Seeding the application with dummy data
+# - 'sail npm install' to install Node.js dependencies on the running container. Since there is a volume attached pointing to the CWD, this will also create the 'node_modules' folder in you computer.
+
+if [[ ! -f .env ]]; then
+    echo "Missing .env file needed to run app. This file is already gitignored so you can create it without it being versioned."
+    exit 1
+fi
+
+./sail up -d laravel.test # Peras: this already spins up the DB service so no need to have a separate command for that
+
+# Peras: 'fresh' does a clean, full migration of the DB. For now I will just keep the 'up' variant and leave the 'fresh' variant commented out
+./migrate.sh up
+# ./migrate.sh fresh
+
+# Peras: insert dummy data into the database
+./seed.sh
 
 ./sail artisan queue:work &
 worker=$!
 
+# ensure we have Vite available
+# Peras: I chose to do a blank dependency installation here to account for missing or broken dependencies
+rm -rf node_modules
+./sail npm install
+
 ./sail npm run dev &
 vite=$!
 
 trap 'kill "$worker"; kill "$vite"; ./sail down' SIGINT
 while kill -s 0 "$worker" || kill -s 0 "$vite"; do
     wait "$worker"
     wait "$vite"
-done &>/dev/null
+done &>/dev/null