Chirper

About

Laravel Chirper Full Stack App was developed based on Laravel Bootcamp, and it is based on Livewire for frontend.

Tools & Libs I use in the Chirper

• PHP

• Laravel

• Livewire

• Laravel Volt

• Laravel Breeze

• Laravel Socialite

• Laravel Sail

• Docker

• SQLite

• Tailwind CSS

• Pusher

• Laravel Echo

Table of Contents

• Docker installation

  • Prerequisites
  • installation

  OR

• Local installation

  • Prerequisites
  • installation

---

Prerequisites with Docker

For a installation with Docker, ensure that you have the following prerequisites installed on your system:

• Docker
• Docker Compose

Installation with Docker

Warning Make sure to follow the requirements first.

Here is how you can run the project with Docker (Laravel Sail):

1. Clone this repo

   git clone https://github.com/saberaldda/chirper.git

2. Go into the project root directory

   cd chirper

3. Copy .env.example file to .env file

   cp .env.example .env

4. Install PHP dependencies with Laravel Sail

   ./vendor/bin/sail up

5. Create database reports (you can change database name)

6. Go to .env file

   • set database credentials

     DB_DATABASE=chirper
     DB_USERNAME=root
     DB_PASSWORD=[YOUR PASSWORD]

   Make sure to follow your database username and password

   • set mail provider credentials

     MAIL_HOST=
     MAIL_PORT=2525
     MAIL_USERNAME=
     MAIL_PASSWORD=
     MAIL_ENCRYPTION=tls

   • set socialite provider credentials

     GITHUB_CLIENT_ID=
     GITHUB_CLIENT_SECRET=
     GITHUB_CALLBACK_URI=
     ...

7. Generate key

   ./vendor/bin/sail artisan key:generate

8. Run migrations & seeders

   ./vendor/bin/sail artisan migrate
   ./vendor/bin/sail artisan db:seed
   

9. Visit http://localhost in your favorite browser.

---

Prerequisites with Local

For a local installation, ensure that you have the following prerequisites installed on your system:

• PHP
• Composer
• Node.js
• npm
• SQLite

Installation with Local

Warning Make sure to follow the requirements first.

Here is how you can run the project locally:

1. Clone this repo

   git clone https://github.com/saberaldda/chirper.git

2. Go into the project root directory

   cd chirper

3. Copy .env.example file to .env file

   cp .env.example .env

4. Create database reports (you can change database name)

5. Go to .env file

   • set database credentials

     DB_DATABASE=chirper
     DB_USERNAME=root
     DB_PASSWORD=[YOUR PASSWORD]

   Make sure to follow your database username and password

   • set mail provider credentials

     MAIL_HOST=
     MAIL_PORT=2525
     MAIL_USERNAME=
     MAIL_PASSWORD=
     MAIL_ENCRYPTION=tls

   • set socialite provider credentials

     GITHUB_CLIENT_ID=
     GITHUB_CLIENT_SECRET=
     GITHUB_CALLBACK_URI=
     ...

6. Install PHP dependencies

   composer update

7. Generate key

   php artisan key:generate

8. Run migrations & seeders

   php artisan migrate:fresh --seed
   

9. Run server

   php artisan serve

10. Visit localhost:8000 in your favorite browser.

    Make sure to follow your Laravel local Development Environment.