From 988251fb9b88153d8dfe1b79bcb7d81f884dcfc4 Mon Sep 17 00:00:00 2001 From: Ishaan Sheikh Date: Sun, 13 Aug 2023 11:16:16 +0530 Subject: [PATCH] added tests badge --- README.md | 24 ++++++++++++++++-------- 1 file changed, 16 insertions(+), 8 deletions(-) diff --git a/README.md b/README.md index 63c7af2..9b6a9a1 100644 --- a/README.md +++ b/README.md @@ -1,14 +1,16 @@ # Tiny crm +[![Tests](https://github.com/frikishaan/tiny-crm/actions/workflows/run-tests.yml/badge.svg?branch=main)](https://github.com/frikishaan/tiny-crm/actions/workflows/run-tests.yml) + This is a small and Open-source CRM application created using the [Filament PHP](https://filamentphp.com/). ## Tech stack -- PHP (Laravel) -- Filament PHP -- Tailwind CSS -- Alpine JS -- PostgreSQL +- PHP (Laravel) +- Filament PHP +- Tailwind CSS +- Alpine JS +- PostgreSQL ## Live demo @@ -17,7 +19,8 @@ The live demo of app is available [here](https://tiny-crm.frikishaan.com/). ## Local Installation 1. Clone the repository -2. Run the following commands - +2. Run the following commands - + ```bash composer install #installing php dependencies @@ -25,6 +28,7 @@ npm install # installing the JS dependencies npm run build # to build the frontend assets ``` + 3. Replace the database credentials in the `.env` file. ``` @@ -37,14 +41,18 @@ DB_PASSWORD=password ``` 4. Now run the following command to create the required tables in database - + ```bash php artisan migrate ``` -Optionally, you can create the dummy data by running the seeder as - + +Optionally, you can create the dummy data by running the seeder as - + ```bash php artisan db:seed ``` +