Skip to content

Latest commit

 

History

History
84 lines (57 loc) · 4.18 KB

README.md

File metadata and controls

84 lines (57 loc) · 4.18 KB

First time setup for local development

  1. Ensure docker and docker-compose are installed

  2. Clone this repo locally

  3. Create symbolic link to local docker-compose:

     ln -s docker-compose.local.yml docker-compose.override.yml

  4. Build tsalpha image using the provided dc wrapper command (this will pass the current UID to avoid permission problems later)

     ./dc build

  5. Create symbolic link to .env.local which contains default app settings

     ln -s .env.local .env

  6. Install composer dependencies

     docker run --rm --interactive --tty --volume $PWD:/app composer:2 composer install

  7. Run the docker images, and wait for database to finish init

     ./dc up

  8. Setup Laravel migration table

     ./dc exec tsalpha php artisan migrate:install

  9. Run database migrations to setup database tables

     ./dc exec tsalpha php artisan migrate

  10. Goto localhost:8000 to test if the app is running

API documentation

We use scribe to automatically generate API documentation

About Laravel

Laravel is a web application framework with expressive, elegant syntax. We believe development must be an enjoyable and creative experience to be truly fulfilling. Laravel takes the pain out of development by easing common tasks used in many web projects, such as:

Laravel is accessible, powerful, and provides tools required for large, robust applications.

Learning Laravel

Laravel has the most extensive and thorough documentation and video tutorial library of all modern web application frameworks, making it a breeze to get started with the framework.

If you don't feel like reading, Laracasts can help. Laracasts contains over 1500 video tutorials on a range of topics including Laravel, modern PHP, unit testing, and JavaScript. Boost your skills by digging into our comprehensive video library.

Laravel Sponsors

We would like to extend our thanks to the following sponsors for funding Laravel development. If you are interested in becoming a sponsor, please visit the Laravel Patreon page.

Premium Partners

Contributing

Thank you for considering contributing to the Laravel framework! The contribution guide can be found in the Laravel documentation.

Code of Conduct

In order to ensure that the Laravel community is welcoming to all, please review and abide by the Code of Conduct.

Security Vulnerabilities

If you discover a security vulnerability within Laravel, please send an e-mail to Taylor Otwell via [email protected]. All security vulnerabilities will be promptly addressed.

License

The Laravel framework is open-sourced software licensed under the MIT license.