New: Installation guide

README.md

@@ -1,5 +1,39 @@
+![image](https://github.com/iNewLegend/web-crawler/assets/10234691/830714f3-c0ec-4b51-add7-d44b0598cc98)
+![image](https://github.com/iNewLegend/web-crawler/assets/10234691/279734f9-88ae-4729-9175-742be5b38b7c)
+
 # Requirements
-- PHP Version: `8.2`
+- MongoDB
+- PHP 
+  - Min Version: `8.2`
+  - MongoDB extension
+  - Composer
+- Node
+    - NPM
+    - Angular CLI
+
+# Installation
+- Clone the repository
+    - $ `git clone https://github.com/iNewLegend/web-crawler.git`
+    - $ `cd web-crawler`
+    - $ `composer install`
+
+
+- Setup mongodb connection
+    - $ `cd crawler-backend`
+    - $ `cp .env.example .env`
+    - $ `vim .env`
+        - Set `MONGODB_URI` to your mongodb connection string
+        - Set `MONGODB_DB` to your mongodb database name
+        - Save and exit
+    - $ Create database collections
+      - $ `php artisan migrate`
+    - $ `cd ..`
+
+
+  - Run backend server
+      - $ `composer dev-start-backend`
+  - Run frontend server (in another terminal)
+      - $ `composer dev-start-frontend`
 
 # Major commits
 -  2023-08-31 08:00:00 ~ 14:30:00 `New: CrawlerLib - Initial Commit`

crawler-backend/.env.example

@@ -8,12 +8,9 @@ LOG_CHANNEL=stack
 LOG_DEPRECATIONS_CHANNEL=null
 LOG_LEVEL=debug
 
-DB_CONNECTION=mysql
-DB_HOST=127.0.0.1
-DB_PORT=3306
+DB_CONNECTION=mongodb
+DB_DSN=mongodb://127.0.0.1:27017/?directConnection=true
 DB_DATABASE=laravel
-DB_USERNAME=root
-DB_PASSWORD=
 
 BROADCAST_DRIVER=log
 CACHE_DRIVER=file