Skip to content

Commit ab339e5

Browse files
committed
fix: update README for improved clarity and organization of sections
1 parent c15b524 commit ab339e5

File tree

1 file changed

+22
-24
lines changed

1 file changed

+22
-24
lines changed

README.md

Lines changed: 22 additions & 24 deletions
Original file line numberDiff line numberDiff line change
@@ -8,18 +8,21 @@
88
<a href="https://shields.io"><img src="https://img.shields.io/github/license/dewanakl/undangan-api?color=brightgreen" alt="License"></a>
99
</p>
1010

11-
## About Kamu
11+
## 📖 About Kamu
1212

1313
"Kamu" merupakan PHP framework yang sangat simpel, memberikan pengalaman seolah-olah berada di localhost meskipun dalam mode production. Dibantu dengan "Saya" konsol yang membantu pengembangan aplikasi secara efisien.
1414

15-
## Api Spec
15+
## 📡 Api Spec
1616

1717
See in postman collection
1818
```url
1919
https://www.postman.com/dewanakl/workspace/undangan/collection/20716209-a29ef362-b4dc-4c02-8904-d90749a40842?action=share
2020
```
2121

22-
## Run without docker
22+
## ☁️ Deployment
23+
24+
<details>
25+
<summary>🛠️ Run without docker</summary>
2326

2427
- Create file env
2528

@@ -50,8 +53,10 @@ https://www.postman.com/dewanakl/workspace/undangan/collection/20716209-a29ef362
5053
```bash
5154
php saya coba
5255
```
56+
</details>
5357

54-
## Run with docker
58+
<details>
59+
<summary>🐳 Run with docker</summary>
5560

5661
- Create file env
5762

@@ -87,13 +92,15 @@ https://www.postman.com/dewanakl/workspace/undangan/collection/20716209-a29ef362
8792
```bash
8893
docker exec undangan-app php saya migrasi --gen
8994
```
95+
</details>
9096

91-
## Deployment on vercel
97+
<details>
98+
<summary>⚡ Deployment on vercel</summary>
9299

93-
- Clone or download this repository
100+
- Create .env file
94101

95102
```bash
96-
git clone https://github.com/dewanakl/undangan-api.git
103+
cp .env.example .env
97104
```
98105

99106
- Install package
@@ -102,10 +109,10 @@ https://www.postman.com/dewanakl/workspace/undangan/collection/20716209-a29ef362
102109
composer install
103110
```
104111

105-
- Create .env file
112+
- Create key application
106113

107114
```bash
108-
cp .env.example .env
115+
php saya key
109116
```
110117

111118
- Execute migration database
@@ -114,17 +121,10 @@ https://www.postman.com/dewanakl/workspace/undangan/collection/20716209-a29ef362
114121
php saya migrasi --gen
115122
```
116123

117-
- Create key application
118-
119-
```bash
120-
php saya key
121-
```
122-
123124
- Push on your github.
124125
- Create new project in vercel.
125126
- Import from your repository.
126-
- Change environment variables in your project on vercel.
127-
- Add this :
127+
- Add environment variables :
128128
- DB_HOST (your host cloud dbms)
129129
- DB_PASS (your password cloud dbms)
130130
- DB_USER (your username cloud dbms)
@@ -136,12 +136,10 @@ https://www.postman.com/dewanakl/workspace/undangan/collection/20716209-a29ef362
136136
- DEBUG [false]
137137
- LOG [false]
138138
- APP_KEY [copy from your local env]
139-
- Click deployments tab in vercel project.
140-
- Click the most recent deploy.
141-
- Click dot three and redeploy.
142139
- Done.
140+
</details>
143141

144-
## Get Started Project
142+
## 🚀 Get Started Project
145143

146144
- Create a project with composer
147145

@@ -161,14 +159,14 @@ https://www.postman.com/dewanakl/workspace/undangan/collection/20716209-a29ef362
161159
php saya coba
162160
```
163161

164-
## Contributing
162+
## 🤝 Contributing
165163

166164
I'm very open to those of you who want to contribute to Kamu framework!
167165
168-
## Security Vulnerabilities
166+
## 🐞 Security Vulnerabilities
169167
170168
If you find a security vulnerability in this Kamu, please email DKL via [dewanakretarta29@gmail.com](mailto:dewanakretarta29@gmail.com).
171169
172-
## License
170+
## 📜 License
173171
174172
Kamu framework is open-sourced software licensed under the [MIT license](https://opensource.org/licenses/MIT).

0 commit comments

Comments
 (0)