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

https://github.com/zzzul/kledo

PT. Kledo Berhati Nyaman - Backend Developer Laravel (Remote) - Back End Assessment V
https://github.com/zzzul/kledo

backend laravel php8 remote rest-api swagger unit-test

Last synced: 2 months ago
JSON representation

PT. Kledo Berhati Nyaman - Backend Developer Laravel (Remote) - Back End Assessment V

Awesome Lists containing this project

README

          

# ๐Ÿš€ Kledo API Project
## ๐Ÿข PT. Kledo Berhati Nyaman
### ๐Ÿ”ง Back End Assessment V

---

## ๐Ÿ“š Table of Contents
1. [โœ… Requirements](#-requirements)
2. [โš™๏ธ Setup](#๏ธ-setup)
3. [๐Ÿ“‘ Swagger Docs](#-swagger)
4. [๐Ÿงช Testing](#-testing)

---

## โœ… Requirements
- ๐Ÿ˜ PHP 8.4
- ๐Ÿฌ MySQL

---

## โš™๏ธ Setup
1. ๐Ÿ”ฝ Clone or download this repository:
```bash
git clone https://github.com/Zzzul/kledo.git
```

2. ๐Ÿ“ Move into the project directory:
```shell
cd kledo
```

3. ๐Ÿ“ฆ Install Laravel dependencies:
```shell
composer install
```

4. ๐Ÿ“ Copy the example environment file:
```shell
cp .env.example .env
```

5. ๐Ÿ” Generate the application key:
```shell
php artisan key:generate
```

6. โš™๏ธ Configure your database settings in ```.env```:
```shell
DB_DATABASE=kledo
DB_USERNAME=root
DB_PASSWORD=
```

7. ๐Ÿ› ๏ธ Run migrations and seed the database:
```shell
php artisan migrate --seed
```
> Seeder only includes status data โœ…

8. โ–ถ๏ธ Start the development server:
```shell
php artisan serve
```

## ๐Ÿ“‘ Swagger
Access the API documentation at: `/api/documentation`

## ๐Ÿงช Testing
To run the tests:
```shell
php artisan test
```