Add installation instructions and sitemap generation in READ.ME

oriolmiro · Mar 17, 2024 · 0b268f4 · 0b268f4
1 parent ea14323
commit 0b268f4
Showing 1 changed file with 10 additions and 0 deletions.
diff --git a/README.md b/README.md
@@ -10,6 +10,16 @@ BookPriceTracker is a Laravel-based web application that helps users track book
 - Price alerts: Allows users to set price alerts for specific books and receive notifications when prices drop.
 - Community contributions: Users can contribute subtitles and translations for video content.
 
+## Installation
+ - Clone the repository to your local machine.
+ - Copy .env.example to .env and configure your environment variables, including database settings.
+ - Generate an application key:
+php artisan key:generate
+ - Run the database migrations and seeders:
+php artisan migrate --seed
+ - To generate the sitemap, navigate to the following URL after starting your server:
+yoursite.com/api/createSitemap
+ - Create the file views/layouts/analytics.blade.php and add your analytics tracking code or any other necessary setup.
 
 ## Contributing