https://github.com/ronald-kimeli/laravel-postcodes-api

This is a laravel Postcode API code where you shall provide a valid Postcode then you will get json response with corresponding Latitude, Longitude and Location where the postcode is located.
https://github.com/ronald-kimeli/laravel-postcodes-api

Last synced: about 1 month ago
JSON representation

This is a laravel Postcode API code where you shall provide a valid Postcode then you will get json response with corresponding Latitude, Longitude and Location where the postcode is located.

• Host: GitHub
• URL: https://github.com/ronald-kimeli/laravel-postcodes-api
• Owner: ronald-kimeli
• Created: 2023-04-13T18:41:01.000Z (over 1 year ago)
• Default Branch: master
• Last Pushed: 2023-10-19T10:06:07.000Z (about 1 year ago)
• Last Synced: 2023-10-19T10:30:26.259Z (about 1 year ago)
• Language: PHP
• Size: 1.84 MB
• Stars: 0
• Watchers: 2
• Forks: 1
• Open Issues: 0
• Metadata Files:
  • Readme: README.md

Awesome Lists containing this project

README

        
# Laravel postcodes API

Build on Laravel RESTFUL API using api_key middleware, jQuery and Bootstrap Css.

You inquire Street Address, Latitude and Longitude using API key and postcode.

## Installation

* clone this project into your machine

```bash

git clone https://github.com/ronald-kimeli/laravel-postcodes-api.git

```

* Install project dependencies

```php

composer install

```

```javascript

npm install

```

* Create .env file through copy

```bash

cp .env.example .env

```

* Provide database credentials below in .env file

```bash

    DB_DATABASE=?

    DB_USERNAME=?

    DB_PASSWORD=?

```

* Generate new key, migrations/seeding and optimize the application before running the server

```php

php artisan migrate:fresh --seed && php artisan key:generate && php artisan optimize

```

## Run the application

* __*On terminal split into two*__

* First one || Run laravel app

```php

php artisan serve

```

* Second One || Run Node for bundling frontend

```php

npm run dev

```

* Navigate to the browser.

## Testing

* __*On Browser*__

You need to copy api_key on the button *API_KEY* and paste as api_key then provide a valid postcode and click search as shown below.

* The blank application before querying locations

![alt text](https://github.com/ronald-kimeli/laravel-postcodes-api/blob/master/public/images/Screenshot1.png?raw=true)

* Input both postcode and api_key then search

![alt text](https://github.com/ronald-kimeli/laravel-postcodes-api/blob/master/public/images/Screenshot2.png?raw=true)

* Success! Query after both valid api_key and postcode.

![alt text](https://github.com/ronald-kimeli/laravel-postcodes-api/blob/master/public/images/Screenshot3.png?raw=true)

> ! Lastly Query more. Note! The locations data is dummy feel free to insert yours and use The end