Skip to content

Latest commit

 

History

History
executable file
·
131 lines (83 loc) · 5.77 KB

readme.md

File metadata and controls

executable file
·
131 lines (83 loc) · 5.77 KB
Raw

About Laravel React Admin

This is a scaffolding project that comes with authentication & users CRUD. It is a Single Page Application (SPA) built on top of React.js in the frontend & Laravel in the backend.

Build Status Latest Version License

Screenshots

Laravel React Admin

Laravel React Admin

Features

  • Progressive Web App (PWA)
  • Supports multiple locales
  • Stateless authentication system
  • Datatables with server-side pagination, sorting & dynamic filtering
  • Undo common actions
  • Docker ready
  • Image Intervention integration for image uploads
  • Drag & drop file uploads.
  • Supports dark mode.

Preview

You can check out the live preview

Quick Start

  1. Clone the repo git clone https://github.com/palonponjovertlota/laravel-react-admin.git.
  2. Go to your project folder from your terminal.
  3. Run: composer install and npm install to install application dependencies.
  4. Copy the env.example file into a .env file and then configure based on your local setup.
  5. Installation is done, you can now run: php artisan serve then npm run watch.
  6. The project will run in this URL: (http://localhost:3000).

Using Docker

If you prefer Docker, there is a working setup provided to get you started in no time. Check your local setup to make sure that running this app in docker will work correctly:

For Unix Based Operating Systems, Give It Proper Permissions

If you are a Linux / Mac user, make sure to give the application proper file permissions. The php-fpm image uses www-data as its default user:

cd ~/your_projects_folder

sudo chown ${USER}:www-data -R laravel-react-admin

Localhost Should Be Freed

Make sure that the address 127.0.0.1:80 usually localhost is available on the host machine. It must be assured that apache2, nginx or any http webserver out there is not running on the host machine to avoid address and port collision.

Add a custom host

To make this app run on docker you must add a custom host address pointing to localhost or 127.0.0.1.

You are good to go

You can now run the image using the docker-compose up and optionally pass the --build flag if you intend to build the image. The app can be visited here http:your_custom_host_address.

Installing PHP & NPM dependencies

In development, do note that all files inside this app is bind-mounted into the container, docker will just use the existing directories, in our concern the vendor and node_modules. Here is an example of running a composer install command: docker container exec -it laravel-react-admin-php-fpm composer install --no-interaction --no-plugins --no-scripts.

Running Artisan Commands

You can run any artisan commands directly into the laravel-react-admin-php-fpm container. Here is an example of a migration command: docker container exec -it laravel-react-admin-php-fpm php artisan migrate:fresh --seed.

What about Browsersync?

As we are bundling frontend assets with webpack under the hood, you must specify the custom host address where the application runs in docker so that webpack can proxy that to be able to develop using docker. You can pass a --env.proxy flag when running for example the npm run watch command: npm run watch -- --env.proxy=http:laravel-react-admin.test.

Using PhpMyAdmin

You could use PhpMyAdmin to browse your MySql database as it is included in this Docker integration. Just add a Virtual Host that points to 127.0.0.1 & the Domain should be the same with your custom host address:

// /etc/hosts

127.0.0.1    phpmyadmin.laravel-react-admin.test

You could then visit PhpMyAdmin here: phpmyadmin.laravel-react-admin.test

Testing

Run the tests with:

// If you have installed composer globally
composer test

// This should also work
./vendor/bin/composer test

Changelog

Please see CHANGELOG for more information on what has changed recently.

Contributing

Please see Contributing for more details.

Security

If you discover any security-related issues, please email [email protected] instead of using the issue tracker.

Credits

  • @reeshkeed for designing the logo & design ideas.

License

The MIT License (MIT). Please see License File for more information.