An open API service indexing awesome lists of open source software.

https://github.com/dewanakl/undangan-api

🔥 API Backend undangan digital Ulems yang andal, sederhana, mudah diintegrasikan, berperforma tinggi, dan dibangun dengan "Kamu PHP Framework".
https://github.com/dewanakl/undangan-api

invitation nikah pernikahan template template-pernikahan template-undangan undangan undangan-digital undangan-online undangan-pernikahan website website-invitation website-pernikahan website-undangan wedding wedding-invitation wedding-page wedding-rsvp wedding-template wedding-website

Last synced: 5 months ago
JSON representation

🔥 API Backend undangan digital Ulems yang andal, sederhana, mudah diintegrasikan, berperforma tinggi, dan dibangun dengan "Kamu PHP Framework".

Awesome Lists containing this project

README

          

kamu


PHP Programming Language
Total Downloads
views
Repo size
License

## 📖 About Kamu

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

## 📡 Api Spec

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

> [!WARNING]
> Gunakan versi 3.7.2, untuk versi 4 masih tahap pengembangan dan berpotensi teredapat bug 🐛

## ☁️ Deployment

🛠️ Run without docker

- Create file env

```bash
cp .env.example .env
```

- Install package

```bash
composer install
```

- Create key application

```bash
php saya key
```

- Execute migration database

```bash
php saya migrasi --gen
```

- Run in development server

```bash
php saya coba
```

🐳 Run with docker

- Create file env

```bash
cp .env.example .env
```

- Change and customize env file

```text
BASEURL=https://your.domain.or.ipaddress:8080/

DB_DRIV=pgsql
DB_HOST=db
DB_PORT=5432
DB_NAME=undangan
DB_USER=root
DB_PASS=12345678

JWT_KEY=valueIsSecure
```

- Build and run image

```bash
docker compose up --build -d
```

- Execute migration

> **_NOTE:_** Wait until the database is ready.

```bash
docker exec undangan-app php saya migrasi --gen
```

⚡ Deployment on vercel

- Create .env file

```bash
cp .env.example .env
```

- Install package

```bash
composer install
```

- Create key application

```bash
php saya key
```

- Execute migration database

```bash
php saya migrasi --gen
```

- Push on your github.
- Create new project in vercel.
- Import from your repository.
- Add environment variables :
- DB_HOST (your host cloud dbms)
- DB_PASS (your password cloud dbms)
- DB_USER (your username cloud dbms)
- DB_NAME (your name of database cloud dbms)
- DB_PORT (your port cloud dbms)
- DB_DRIV (type cloud dbms [ex. mysql or pgsql])
- JWT_KEY [ex. 123]
- HTTPS [true]
- DEBUG [false]
- LOG [false]
- APP_KEY [copy from your local env]
- Done.

## 🚀 Get Started Project

- Create a project with composer

```bash
composer create-project kamu/kamu coba-app
```

- Move the folder

```bash
cd coba-app
```

- Run in development server

```bash
php saya coba
```

## 🤝 Contributing

I'm very open to those of you who want to contribute to Kamu framework!

## 🐞 Security Vulnerabilities

If you find a security vulnerability in this Kamu, please email DKL via [dewanakretarta29@gmail.com](mailto:dewanakretarta29@gmail.com).

## 📜 License

Kamu framework is open-sourced software licensed under the [MIT license](https://opensource.org/licenses/MIT).