Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/kemalyen/product-api
A sample product API server applications
https://github.com/kemalyen/product-api
Last synced: about 2 months ago
JSON representation
A sample product API server applications
- Host: GitHub
- URL: https://github.com/kemalyen/product-api
- Owner: kemalyen
- Created: 2023-09-18T19:28:34.000Z (over 1 year ago)
- Default Branch: main
- Last Pushed: 2024-10-25T16:15:35.000Z (2 months ago)
- Last Synced: 2024-10-25T21:58:18.278Z (2 months ago)
- Language: HTML
- Size: 692 KB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
## Product API Application
This repository is under heavy development. Please, visit the repository later.
After cloning the repository, you should run composer to download and install the packages.
```
composer install
```
Rename `.env.sample` to `.env` . Run the migrator with the database seeder. This will create an SQLite database with some sample data.
```
php artisan migrate --seed
```
Start the built-in server to run the application
```
php artisan serve
```
### Running test
You may run the test using the following command. The tests are written using PEST.
```
php artisan test
```
### API Documentation
Postman Collection (https://github.com/kemalyen/product-api/blob/main/public/docs/collection.json)
Open API (https://github.com/kemalyen/product-api/blob/main/public/docs/openapi.yaml)
Web-based documents are located at HTTP://localhost/docs/index.html
If you want to re-generate your API, simple just run following command:
```
php artisan scribe:generate
```
## License
The Laravel framework is open-sourced software licensed under the [MIT license](https://opensource.org/licenses/MIT).