Skip to content

Commit

Permalink
added tests badge
Browse files Browse the repository at this point in the history
  • Loading branch information
frikishaan committed Aug 13, 2023
1 parent 99df7af commit 988251f
Showing 1 changed file with 16 additions and 8 deletions.
24 changes: 16 additions & 8 deletions README.md
Original file line number Diff line number Diff line change
@@ -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

Expand All @@ -17,14 +19,16 @@ 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

npm install # installing the JS dependencies

npm run build # to build the frontend assets
```

3. Replace the database credentials in the `.env` file.

```
Expand All @@ -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
```

<!--
## Need Consultancy?
## Need Consultancy?
If you need help customizing this application or want to create your own application like this, contact me [here](https://www.upwork.com/services/product/consulting-hr-a-customer-crm-software-1651120102232907776?ref=project_share).
-->

0 comments on commit 988251f

Please sign in to comment.