Admin and Users

This application is a demo. I'm using context based modules, approach that I took out of the Elixir/Phoenix environment.

Installation

To run the demo locally, you will need:

• Docker;
• docker-compose;
• PHP +7.2 & Composer;
• Node & yarn;

With those, you can proceed to the steps bellow:

• Clone this repo
• Run cp .env.example .env
• Run composer install
• Run docker-compose up -d
• Run docker-compose exec app bash to get a shell inside the application container and run the migrations and passport install commands on it:
  • Run php artisan key:generate (for local env only)
  • Run php artisan migrate
  • Run php artisan db:seed (for local env only)
  • Run php artisan passport:install
  • Run exit to get out of the container
• Pull and compile assets:
  • Run yarn && yarn dev
• Load the application in the browser at http://localhost. You can use these credentials to authenticate
  • Email: admin@example.com
  • Pass: secret
• Generate the API documentation (TODO):
  • Run composer generate:api-docs
  • Access http://localhost/api/docs

Troubleshooting

If you have problems with permission when loading the application, make sure you follow the steps:

• Run chown -R $(id -u):www-data ./storage (to change the ownership of files in the storage folder)
• Run chmod -R ug+rw ./storage (to allow user and group to read and write in the storage folder)

Documentation

• You can find some Sequence Diagrams here
• The ER model also can be found here