Ecosyste.ms: Awesome

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

Awesome Lists | Featured Topics | Projects

https://github.com/ikhsan3adi/auction_app_api_ci4

RESTful API service for Flutter-Auction-App using CodeIgniter 4
https://github.com/ikhsan3adi/auction_app_api_ci4

codeigniter codeigniter4 jwt jwt-authentication php rest-api restful-api

Last synced: 3 months ago
JSON representation

RESTful API service for Flutter-Auction-App using CodeIgniter 4

Host: GitHub
URL: https://github.com/ikhsan3adi/auction_app_api_ci4
Owner: ikhsan3adi
License: mit
Created: 2023-04-09T06:33:29.000Z (over 1 year ago)
Default Branch: master
Last Pushed: 2024-05-15T03:14:50.000Z (8 months ago)
Last Synced: 2024-10-01T00:41:34.141Z (3 months ago)
Topics: codeigniter, codeigniter4, jwt, jwt-authentication, php, rest-api, restful-api
Language: PHP
Homepage:
Size: 261 KB
Stars: 13
Watchers: 1
Forks: 3
Open Issues: 2
Metadata Files:
- Readme: README.md
- License: LICENSE

Awesome Lists containing this project

README

        # Flutter Auction App RESTful API Service

[![Continuous Integration](https://github.com/ikhsan3adi/auction_app_api_ci4/actions/workflows/ci.yml/badge.svg)](https://github.com/ikhsan3adi/auction_app_api_ci4/actions/workflows/ci.yml)

 REST API for [Flutter Auction App](https://github.com/ikhsan3adi/flutter-auction-app) using Codeigniter 4

## Requirement

- Composer

- **PHP 8.1+ & MySQL** or **XAMPP** with `-intl` extension enable

## Configuration

1.  Rename `.env.example` file to `.env`.

2.  Set the jwt secretkey and token expiration in the `.env` file if you want to change them.

3.  Install dependencies:

```shell

    composer install

```

4. Create `db_online_auction` database

5.  Ensure your database is setup correctly, then run the migrations: 

```shell

    php spark migrate -all  

```

6.  Run the app: 

```shell

    php spark serve  

```

> http://localhost:8080

## API Reference

#### Login

```

POST   /api/login

```

| Parameter  | Type     | Description                 |

| :--------  | :------- | :-------------------------  |

| `username` | `string` | **Required**. Your username |

| `password` | `string` | **Required**. Your password |

#### Register user

```

POST   /api/users

```

| Parameter      | Type     | Description    |

| :--------      | :------- | :--------------|

| `username`     | `string` | **Required**.  |

| `password`     | `string` | **Required**.  |

| `name`         | `string` | **Required**.  |

| `email`        | `string` | **Required**.  |

| `phone`        | `string` |                |

---

Warning :warning: Make sure to add authorization header (Bearer token)

#### Get auction

```

GET    /api/auctions

```

```

GET    /api/auctions/{id}

```

#### Get user/my auctions

```

GET    /api/users/auctions

```

#### Get auction bids

```

GET    /api/auctions/{id}/bids

```

---

#### Create an auction

```

POST   /api/auctions

```

#### Update an auction

```

PATCH  /api/auctions/{id}

```

#### Set winner & close auction

```

PATCH  /api/auctions/{id}/winner

```

```

PATCH  /api/auctions/{id}/close

```

#### Delete an auction

```

DELETE /api/auctions/{id}

```

---

#### Get bid

```

GET    /api/bids

```

```

GET    /api/bids/{id}

```

#### Get user/my bids

```

GET    /api/users/bids

```

---

#### Create/place a bid

```

POST   /api/bids

```

#### Update bid

```

PATCH  /api/bids/{id}

```

#### Delete bid

```

DELETE /api/bids/{id}

```

---

#### Get item

```

GET    /api/items

```

```

GET    /api/items/{id}

```

#### Create an item

```

POST   /api/items

```

#### Update an item

```

PATCH  /api/items/{id}

```

#### Delete an item

```

DELETE /api/items{id}

```

---

#### Get user

```

GET    /api/users

```

```

GET    /api/users/{id}

```

#### Update user

```

PATCH  /api/users/{id}

```

#### Delete user

```

DELETE /api/users/{id}

```

Still need more improvement

## Contributing

Pull requests are welcome. For major changes, please open an issue first

to discuss what you would like to change.

## Donation

[![Donate paypal](https://img.shields.io/badge/Donate-PayPal-green.svg?style=for-the-badge)](https://paypal.me/xannxett?country.x=ID&locale.x=en_US)

[![Donate saweria](https://img.shields.io/badge/Donate-Saweria-red?style=for-the-badge&link=https%3A%2F%2Fsaweria.co%2Fxiboxann)](https://saweria.co/xiboxann)

## License

![GitHub license](https://img.shields.io/github/license/ikhsan3adi/ci4_online_auction_api?style=for-the-badge)

## Authors

- [@ikhsan3adi](https://www.github.com/ikhsan3adi)