/Laravel-RESTful-API

Primary LanguagePHPApache License 2.0Apache-2.0

Laravel API example

A simple restful api for realtors that creates appointments and calculates distances based on location

Table of Contents
  1. About The Project
  2. Getting Started
  3. Contributing
  4. License
  5. Contact

About The Project

(back to top)

Built With

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.

(back to top)

Getting Started

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.

Prerequisites

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)

Manual Installation

  1. Clone the repo 
    git clone https://github.com/metinagaoglu/Laravel-API-example
  2. Move source directory 
    cd src/
  3. Copy the .env file. 
    cp .env.example .env
  4. Configure your database,google maps api keys etc. settings
POSTCODES_URL=https://api.postcodes.io/
REAL_ESTATE_AGENT_POSTCODE=
GOOGLE_MAPS_API=
  1. Install dependency 
    composer install
  2. Generate key 
    php artisan key:generate
  3. Generate jwt secret key 
    php artisan jwt:secret
  4. Run migrate command (Be sure your db settings are correct) 
    php artisan migrate
  5. Run the development serve 
    php artisan serve
  6. Send the get request 
    localhost:8000

(back to top)

Contributing

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!

  1. Fork the Project
  2. Create your Feature Branch (git checkout -b feature/AmazingFeature)
  3. Commit your Changes (git commit -m 'Add some AmazingFeature')
  4. Push to the Branch (git push origin feature/AmazingFeature)
  5. Open a Pull Request

(back to top)

License

Distributed under the MIT License. See LICENSE.txt for more information.

(back to top)

Contact

Metin Ağaoğlu - @metnagaoglu - metnagaoglu@gmail.com

(back to top)