Base Environment

OSB: At the root of the project there is a Postman collection

Installation

• First, you need to clone this repository: Note I recommend cloning it inside a project folder, for example

  • After cloning the base environment, run the following commands to start the setup: Note these commands assume you are in the folder where you cloned the project

  cd ./BasicEnvironment
  
  chmod +x ./scripts/ # Execution permission for the scripts
  
  ./scripts/start-environment.sh # Clones the applications and starts the environment configuration

  This will start the environment configuration.
  During the authenticator setup, it will ask you to run the passport migrations with the following message:

      INFO  Publishing [passport-migrations] assets.  
  
      Copying directory [vendor/laravel/passport/database/migrations] to [database/migrations] .................................................... DONE
  
      Would you like to run all pending database migrations? (yes/no) [yes]
  

  • type no
  • the migrations will be executed afterwards by the script

• The authenticator will generate the private and public keys. You won’t have these keys in the project at first.

  • To copy the public key to the other projects that will decode the authorization token, simply run the following command:

  ./scripts/copy-key.sh

  • Note: this practice is only being used because this is a development environment
  • After this, the keys will be copied to the applications’ repositories and also to the Keys folder inside the current BasicEnvironment folder.

• Now, just uncomment the commands in the docker-compose.yml

  • They are commented out by default so the scripts can perform the configuration
  • Now just run:

  docker compose down
  docker compose up #-d to run in the background

NOTE: The services currently use the servers provided by the libraries. Soon I will add services using nginx or something similar.

Flow of Services