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

https://github.com/ghiftee/hngx-stage-two


https://github.com/ghiftee/hngx-stage-two

Last synced: about 1 year ago
JSON representation

Awesome Lists containing this project

README

          

## Person resource API

This project is the HNGx stage two backend task which perfomrs simple CRUD operations.

## Table of Contents

- [Installation](#installation)
- [Usage](#usage)
- [Source Code](#source-code)
- [License](#license)

## Installation
1. Clone the repository.
2. Install dependencies with `composer install`.
3. Set up your database configuration in `.env`.
4. Run migrations with `php artisan migrate`.
5. Start the development server with `php artisan serve`.

## Usage

> Please refer to the [DOCUMENTATION](./DOCUMENTATION.md) file for details on the API endpoints and how to make requests.

## Source Code

> The source code can be found in the [Controller](https://github.com/Ghiftee/hngx-stage-two/blob/main/app/Http/Controllers/PersonController.php) folder

## License

> This project is [MIT Licensed](./LICENSE).