Skip to content
This repository has been archived by the owner on May 28, 2021. It is now read-only.

disttant/api

Repository files navigation

About API

Framework info (Mar/2020)

  • Laravel 6

Dependencies

  • PHP >= 7.2.0
  • BCMath PHP Extension
  • Ctype PHP Extension
  • JSON PHP Extension
  • Mbstring PHP Extension
  • OpenSSL PHP Extension
  • PDO PHP Extension
  • Tokenizer PHP Extension
  • XML PHP Extension

Preparing

Installing for production

1. The hard way

  1. Install Composer, Git
  2. Clone the repository to a temporary folder
  3. Copy composer.json and composer.lock to the final location
  4. Go to that folder:
cd /final/location
  1. Execute:
composer install --no-dev --no-scripts
  1. Move the temporary folder's content to the final location
  2. Re-build the autoload file executing:
composer dump-autoload
  1. Configure .env file
  2. Create your DB tables executing:
php artisan migrate
  1. Give the right permissions to the files:
find /final/location -type f -exec chmod 644 {} \;
find /final/location -type d -exec chmod 755 {} \;
  1. Configure the web server (like Nginx) to route all the requests to public/index.php

2. The easy way (testing mode)

0. Install Docker
1. Clone the repository
2. Build the image with the Dockerfile included
3. Upload the image to a repository
4. Use the image with Compose or Kubernetes
   * Set all the environment variables Laravel uses
     + APP_VENDOR
     + APP_NAME
     + [...]
   * Set OAuth routes as environment vars
     + OAUTH_URI
     + OAUTH_CHECK_TOKEN_ROUTE

   * Mount /var/www in a volume
   * Mount /var/www/storage into a volume

Now, your container is listening on port 9000 (PHP_FPM)

You just must configure an NGINX container in the way Laravel documentation explains to use the app

Security Vulnerabilities

If you discover security vulnerabilities, please send an e-mail to Alby Hernández [[email protected]].

All security vulnerabilities will be fixed as soon as we notice them.

License

This is privative software and it is NOT allowed to redistribute any copy neither partial not complete.