fix: Added contributing guide

antoniputra · May 25, 2024 · 83cfcaf · 83cfcaf
1 parent 357859e
commit 83cfcaf
Show file tree

Hide file tree

Showing 7 changed files with 61 additions and 21 deletions.
diff --git a/art/sample-1.png → art/preview-dashboard.png b/art/sample-1.png → art/preview-dashboard.png
diff --git a/art/preview-starter-page.png b/art/preview-starter-page.png
diff --git a/dist/ngeblog-admin-assets/ngeblog.js b/dist/ngeblog-admin-assets/ngeblog.js
diff --git a/package-lock.json b/package-lock.json
diff --git a/package.json b/package.json
@@ -16,7 +16,7 @@
     "@vitejs/plugin-vue": "^5.0.4",
     "@vueuse/core": "^10.9.0",
     "autoprefixer": "^10.4.19",
-    "axios": "^1.6.8",
+    "axios": "^1.7.2",
     "daisyui": "^4.11.1",
     "laravel-precognition-vue": "^0.5.4",
     "postcss": "^8.4.38",

diff --git a/readme.md b/readme.md
@@ -20,9 +20,19 @@ It helps you to quickly set up a simple **Blogging System** for your existing or
 - and more...
 
 ### Screenshot
+
+#### Preview of Dashboard page.
 <p align="center">
-	<a href="https://raw.githubusercontent.com/antoniputra/ngeblog/main/art/sample-1.png" target="_blank">
-		<img src="https://raw.githubusercontent.com/antoniputra/ngeblog/main/art/sample-1.png" alt="Ngeblog Screenshot">
+	<a href="https://raw.githubusercontent.com/antoniputra/ngeblog/main/art/preview-dashboard.png" target="_blank">
+		<img src="https://raw.githubusercontent.com/antoniputra/ngeblog/main/art/preview-dashboard.png" alt="Ngeblog Screenshot">
+	</a>
+</p>
+
+
+#### Preview of Starter page.
+<p align="center">
+	<a href="https://raw.githubusercontent.com/antoniputra/ngeblog/main/art/preview-starter-page.png" target="_blank">
+		<img src="https://raw.githubusercontent.com/antoniputra/ngeblog/main/art/preview-starter-page.png" alt="Ngeblog Screenshot">
 	</a>
 </p>
 
@@ -67,13 +77,43 @@ Gate::define('accessNgeblogAdmin', function ($user) {
 ```
 
 
+## Contributing Guide
+
+I glad to see you here on this section. Whether you're a seasoned developer or new to open source, your participation is valuable. Let's collaborate and learn together! 🚀
+
+Follow the steps below to get started.
+
+### Back-end Dependencies:
+- Laravel 11
+- Pest, Testbench
+
+### Front-end Dependencies:
+- Vue 3 & VueRouter (script-setup)
+- Tailwind & DaisyUI.
+- Tiptap Editor, HeadlessUI, VueUse, FloatingUI.
+
+### Steps to Contribute:
+1. Fork and clone the repo, then navigate to the project folder.
+2. Install dependencies: `composer install` & `npm install`.
+3. Run the app: `composer serve`.
+
+### Asset Building:
+- For development (rebuilds on save):
+  ```bash
+  npm run watch
+  ```
+- Before pushing code (minified version):
+  ```bash
+  npm run build
+  ```
+
 ## Credits
 
-- Thanks to [@arryanggaputra](https://github.com/arryanggaputra) for the _nice looking logo_.
+- Thanks to [@arryanggaputra](https://github.com/arryanggaputra) for the nice looking logo.
 
 
 ## License
 
 **Ngeblog** is open-sourced software licensed under the [MIT license](http://opensource.org/licenses/MIT).
 
-Built with love by @antoni_putra12 and made better by you.
+Built with love by @antoni_putra12 and made better by you.
diff --git a/workbench/database/seeders/DummyDataSeeder.php b/workbench/database/seeders/DummyDataSeeder.php
@@ -23,7 +23,7 @@ public function run(): void
         ]);
 
         for ($i=0; $i < 10; $i++) {
-            $title = fake()->words(rand(2, 3), true);
+            $title = fake()->randomLetter() . fake()->words(rand(2, 3), true);
             $date = fake()->dateTimeBetween('-1 months');
             Tag::create([
                 'title' => $title,
@@ -36,7 +36,7 @@ public function run(): void
         }
 
         for ($i=0; $i < 20; $i++) { 
-            $title = fake()->sentence();
+            $title = fake()->randomLetter() . fake()->sentence();
             $date = fake()->dateTimeBetween('-1 months');
             $post = Post::create([
                 'author_id' => $user->id,