User Stories

• Installation
• Setting up 3rd-part Services -Mailtrap
• Workflows -Compiling assests
• Making Pull Requests

Installation

Follow these steps to setup the development environment.

1. Clone the repo: git clone [email protected]:Light-it-labs/user-stories.git user-stories
2. Initialize git flow repository with default configs: git flow init
3. Create your environment config: cp .env.example .env
4. Install the Composer dependencies: composer install
5. Create a random application key: php artisan key:generate
6. Setup the storage: php artisan storage:link
7. Setup required 3rd-party services
8. Seed the database: php artisan migrate:fresh --seed
9. Create a personal access client: php artisan passport:client --personal
10. Setup laravel passport: php artisan passport:install
11. Install the NPM dependencies: npm install
12. Compile all assets: npm run dev

You’re done, checkout the app at http://localhost:8000.

Setting up 3rd-party Services

Mailtrap

Mailtrap is a fake SMTP server to test and view emails sent from the development environment.

• Signup for a free account on mailtrap.io
• Set your MAIL_USERNAME and MAIL_PASSWORD in your .env file

Pusher

Pusher is a hosted service that makes it easy to add real-time data and functionality to web and mobile applications

• Signup for a free account on pusher.com
• Set your PUSHER_APP_ID, PUSHER_APP_KEY and PUSHER_APP_SECRET in your .env file

Workflows

Compiling assets

You can compile assets inside the workbench:

npm run dev

To continuously watch for file changes:

npm run watch

Making Pull Requests

• The development branch is develop
• Use git flow feature start name-of-feature to create new branch