Plog

A blog app made with Laravel and React. 🔥

🚀 Setup Guide

🛠 Prerequisites

Make sure you have the following installed on your machine:

• PHP 🐘
• Composer 🎻
• Laravel Installer 🐛
• Node.js 🧩
• NPM 📦

For a quick guide on how to install, laravel has great instructions: Guide

---

⚡️ Getting Started

Follow these steps to set up and run the Laravel application locally.

1. Clone the Repository 📂

• 1.1 With git:

git clone https://github.com/momcilovicluka/plog.git

or

• 1.2 With GitHub cli:

gh repo clone momcilovicluka/plog

2. Navigate to the Project Directory 📁

cd plog

3. Install Dependencies 🚀

Install the PHP dependencies using Composer and node deps with npm:

composer install
npm install

Then compile the assets:

npm run build

4. Set Up Environment Variables 🌍

Create a .env file by copying the example:

cp .env.example .env

5. Generate Application Key 🔑

Run the following command to generate an encryption key for your application:

php artisan key:generate

6. Set up Database 💿

Create a SQLite database file:

touch database/database.sqlite

Run migrations to create tables:

php artisan migrate:fresh

Run seeders to populate the tables with mock data:

php artisan db:seed

⚠ Password for every user is: password

All users are randomly generated except following 2 which are always created:

• [email protected]
• [email protected]

7. Test the application! 🧪

Before running the tests, make sure to createa a db file dedicated to testing.

Failing to do so will force the tests to run on default database resulting in an empty database after testing.

You can create a db file for testing like so(it's already linked in env.testing):

touch database/testing.sqlite

To run all the tests use:

php artisan test

To run only unit tests:

php artisan test --testsuite=Unit

To run only feature tests:

php artisan test --testsuite=Feature

8. Run the application! 💨

php artisan serve

Although it can be run with docker, it is recommended to run it with sail ⛵

./vendor/bin/sail up

You can also run it with docker if you're really keen 🐳:

docker compose up

---

👷‍♂️Currently, there are 2 active Workflows / GitHub Actions:

• Laravel Test & Format
  • This workflow pulls the repository, sets up the environment, compiles the code, and executes the tests.
  • If all tests are successful, Pint will run to fix the code style and create a commit.
• Lint Code Base
  • If the previous workflow completes successfully, the super linter will run to ensure everything adheres to the established standards.

---

About Laravel

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:

• Simple, fast routing engine.
• Powerful dependency injection container.
• Multiple back-ends for session and cache storage.
• Expressive, intuitive database ORM.
• Database agnostic schema migrations.
• Robust background job processing.
• Real-time event broadcasting.

Laravel is accessible, powerful, and provides tools required for large, robust applications.

Learning Laravel

Laravel has the most extensive and thorough documentation and video tutorial library of all modern web application frameworks, making it a breeze to get started with the framework.

You may also try the Laravel Bootcamp, where you will be guided through building a modern Laravel application from scratch.

If you don't feel like reading, Laracasts can help. Laracasts contains thousands of 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 Partners program.

Premium Partners

• Vehikl
• Tighten Co.
• WebReinvent
• Kirschbaum Development Group
• 64 Robots
• Curotec
• Cyber-Duck
• DevSquad
• Jump24
• Redberry
• Active Logic
• byte5
• OP.GG

Contributing

Thank you for considering contributing to the Laravel framework! The contribution guide can be found in the Laravel documentation.

Code of Conduct

In order to ensure that the Laravel community is welcoming to all, please review and abide by the Code of Conduct.

Security Vulnerabilities

If you discover a security vulnerability within Laravel, please send an e-mail to Taylor Otwell via [email protected]. All security vulnerabilities will be promptly addressed.

License

The Laravel framework is open-sourced software licensed under the MIT license.