Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/nazemmahmud/bongo-restaurant
https://github.com/nazemmahmud/bongo-restaurant
Last synced: about 1 month ago
JSON representation
- Host: GitHub
- URL: https://github.com/nazemmahmud/bongo-restaurant
- Owner: NazemMahmud
- Created: 2019-11-13T23:43:42.000Z (about 5 years ago)
- Default Branch: master
- Last Pushed: 2023-02-02T08:46:20.000Z (almost 2 years ago)
- Last Synced: 2023-03-06T04:47:15.153Z (almost 2 years ago)
- Language: PHP
- Size: 190 KB
- Stars: 0
- Watchers: 2
- Forks: 0
- Open Issues: 2
-
Metadata Files:
- Readme: readme.md
Awesome Lists containing this project
README
# Building Restaurant API and corresponding test cases
I have developed this using Laravel 5.8 and MySQL.
### Prerequisites
To run this, you need to install,
* Git.
* PHP.
* Composer.
* Laravel CLI.
* A webserver ( I have used Apache).
### Install
Clone the git repository on your computer
You can also download the entire repository as a zip file and unpack in on your computer if you do not have git
After cloning the application, you need to update the composer from the project directory.
```
$ composer update
```
### Setup
- Generate the application key
```$ php artisan key:generate```
- In `.env` file, database configuration is given. Create the database. You may take the database name from DB_DATABASE value. Or, you may modify it as your own
- Migrate the application
```$ php artisan migrate```
- I have provided the sql file for restaurants table data (**restaurants.sql**). Import that data into restaurants table
### Run the application
```$ php artisan serve```
## API CHECK
- You can check the API in postman. I have used Laravel resource API. API route Lists are in ```routes\api.php``` files.
- For postman, APIs will be look like this:
1. http://127.0.0.1:8000/api/restaurant-list to get all restaurants order by opening state default.
2. http://127.0.0.1:8000/api/search-restaurants?searchKey=king to search restaurant by restaurant name
3. http://127.0.0.1:8000/api/sort-restaurants?sortBy=ratingAverage&orderby=asc to sort restaurant based on column in restaurant table. If you provide empty value for **orderBy** paramter, it will sort in descending order by default.
- Corresponding Controller, Model and Resources files are in **```app\Http\Controllers```**, **```app\Http```** , **```app\Http\Resources```** directory respectively. You can check there how this API works. Necessary comments are added above the corresponding methods
## Unit Test
- I have added test cases for unit test in ```tests\Unit\RestaurantTest.php``` file. To check, this at first create a sqlite database file,
```$ touch database/test.sqlite```
- Then, seed the testing data from seeder by running following command:
```php artisan migrate --seed --env=testing```
- Now, if you run the following command, you can see the test cases output for unit test.
```./vendor/bin/phpunit```