A simple restful api for realtors that creates appointments and calculates distances based on location
Table of Contents
This section should list any major frameworks/libraries used to bootstrap your project. Leave any add-ons/plugins for the acknowledgements section. Here are a few examples.
This is an example of how you may give instructions on setting up your project locally. To get a local copy up and running follow these simple example steps.
This is an example of how to list things you need to use the software and how to install them.
- PHP8
- Composer
- PostgesQL(Recommended) or MariaDB
- Docker(Optional)
- Clone the repo
git clone https://github.com/metinagaoglu/Laravel-API-example
- Move source directory
cd src/ - Copy the .env file.
cp .env.example .env
- Configure your database,google maps api keys etc. settings
POSTCODES_URL=https://api.postcodes.io/
REAL_ESTATE_AGENT_POSTCODE=
GOOGLE_MAPS_API=- Install dependency
composer install
- Generate key
php artisan key:generate
- Generate jwt secret key
php artisan jwt:secret
- Run migrate command (Be sure your db settings are correct)
php artisan migrate
- Run the development serve
php artisan serve
- Send the get request
localhost:8000
Contributions are what make the open source community such an amazing place to learn, inspire, and create. Any contributions you make are greatly appreciated.
If you have a suggestion that would make this better, please fork the repo and create a pull request. You can also simply open an issue with the tag "enhancement". Don't forget to give the project a star! Thanks again!
- Fork the Project
- Create your Feature Branch (
git checkout -b feature/AmazingFeature) - Commit your Changes (
git commit -m 'Add some AmazingFeature') - Push to the Branch (
git push origin feature/AmazingFeature) - Open a Pull Request
Distributed under the MIT License. See LICENSE.txt for more information.
Metin Ağaoğlu - @metnagaoglu - metnagaoglu@gmail.com