Skip to content

Commit

Permalink
docs(readme): add workflow and seeder explanation
Browse files Browse the repository at this point in the history
  • Loading branch information
momcilovicluka committed Oct 28, 2024
1 parent 02287ce commit f93ac98
Showing 1 changed file with 13 additions and 1 deletion.
14 changes: 13 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
<div align="center">
<h1><b>Plog</b></h1>
<h3>A blog app made with Laravel and react. 🔥 </h3>
<h3>A blog app made with Laravel and React. 🔥 </h3>

![GitHub Repo stars](https://img.shields.io/github/stars/momcilovicluka/plog?style=for-the-badge&color=ff0050)
![GitHub last commit](https://img.shields.io/github/last-commit/momcilovicluka/plog?style=for-the-badge&color=ff0050)
Expand Down Expand Up @@ -80,6 +80,11 @@ Run seeders to populate the tables with mock data:
```bash
php artisan db:seed
```
⚠ Password for every user is: `password`

All users are randomly generated except following 2 which are always created:
- guest@gmail.com
- admin@example.com

### 7. Test the application! 🧪
Before running the tests, make sure to createa a db file dedicated to testing.
Expand Down Expand Up @@ -117,6 +122,13 @@ 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.
---

<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>

Expand Down

0 comments on commit f93ac98

Please sign in to comment.