Code Monkey home page Code Monkey logo

laravel-project-template's Introduction

Project Name

[Include a brief description or introduction of your project here]

Table of Contents

Installation

[Provide instructions on how to install and set up your Laravel project. Include any dependencies or prerequisites that need to be installed and how to obtain them.]

composer create-project appwise-labs/laravel-template project-name
cd project-name

Environment variables

Set up the following environment variables in your .env file:

TEST_ENV_VARIABLE=example_value

Credentials

You can find the credentials for this project in 1password or on confluence: [link to confluence page]

Usage

[Explain how to use your Laravel project, including any important commands or features. Provide examples and instructions for common tasks.]

Before running the project

php artisan passport:keys

To use a temporary development database. This database is empty upon start, and will clear every reboot. To clear this database, you can run npm run down

npm run up

To clear this database, you can run npm run down and npm run up again.

For local development run

php artisan serve

To fix code style

# Run pint and change the code
./vendor/bin/pint
or
npm run pint

# Run pint without changing the code
./vendor/bin/pint --test
or
npm run pint-test

# Run pint only on changed files
./vendor/bin/pint --dirty
or
npm run pint-dirty

To run your tests

./vendor/bin/pest
or
npm run test

TODO: To generate API documentation

php artisan ...

Before pushing to git, run PHPStan to analyse your code

./vendor/bin/phpstan analyse src tests
or
npm run phpstan

Features

[List the main features or functionalities of your Laravel project. You can provide a brief description of each feature and explain how it benefits the users or developers.]

  • Feature 1: [Description]
  • Feature 2: [Description]
  • Feature 3: [Description]

Entry points

[Provide a list of entry points for your Laravel project. These are the routes that can be accessed by the user. Include a brief description of each route.]

Production Setup

[Provide instructions on how to set up your Laravel project for production. Include any dependencies or prerequisites that need to be installed and how to obtain them.]

Site URLs

  • Production URL: [URL]
  • Staging URL: [URL]
  • Testing URL: [URL]
  • Development URL: [URL]

Documentation

[Provide a link to the documentation for your Laravel project. This can be a link to a Confluence page.]

Sentry

composer require sentry/sentry-laravel

laravel-project-template's People

Contributors

bertbijnens avatar djbe avatar ascanius95 avatar daanpersoons-appwise avatar

Watchers

James Cloos avatar  avatar Martijn Segers avatar  avatar  avatar

laravel-project-template's Issues

Implement development authorization grant

Testing with different user accounts on apps is currently difficult due unknown passwords or social logins.
We could make this easier by developing a method to provide the apps with a refresh token of the user.

  • deeplink/url-schema's to web/apps with the refresh token

When using a PKCE authorization flow, we could handle this in the login web interface

Force Https

When hosted behind a proxy, Laravel will create http:// url's instead of https:// urls.
We can enforce Https by setting
URL::forceScheme('https');
in the AppServiceProvider' boot method.
In the local env we should enable http

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.