Skip to content

Commit 4827551

Browse files
committed
Updated readme
1 parent f89f6b1 commit 4827551

File tree

1 file changed

+23
-4
lines changed

1 file changed

+23
-4
lines changed

README.md

Lines changed: 23 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -13,8 +13,13 @@ This is a small and Open-source CRM application created using the [Filament PHP]
1313

1414
## Local Installation
1515

16-
1. Clone the repository
17-
2. Run the following commands -
16+
### Clone the repository
17+
18+
```bash
19+
git clone https://github.com/frikishaan/tiny-crm.git
20+
```
21+
22+
### Install dependencies
1823

1924
```bash
2025
composer install #installing php dependencies
@@ -24,9 +29,23 @@ npm install # installing the JS dependencies
2429
npm run build # to build the frontend assets
2530
```
2631

27-
3. Replace the database credentials in the `.env` file.
32+
### Create environment file
2833

34+
```bash
35+
cp .env.example .env
2936
```
37+
38+
### Generate application key
39+
40+
```bash
41+
php artisan key:generate
42+
```
43+
44+
### Update environment variables
45+
46+
Replace the following values in `.env` file with your database credentials. For example -
47+
48+
```bash
3049
DB_CONNECTION=pgsql
3150
DB_HOST=127.0.0.1
3251
DB_PORT=5432
@@ -35,7 +54,7 @@ DB_USERNAME=postgres
3554
DB_PASSWORD=password
3655
```
3756

38-
4. Now run the following command to create the required tables in database -
57+
### Migrate the database
3958

4059
```bash
4160
php artisan migrate

0 commit comments

Comments
 (0)