About Squeaker

Squeaker is a Twitter clone made with Laravel and Vue.js. Squeaker has the same features as Twitter like posting aka squeaking, following, liking, and more!

Look at the screenshots section to see how the application looks like.

Setting up the project

Here is the section on how to set up the project, and run it properly.

Requirements

This projects requires a few things to have to be installed on your computer.

MYSQL Server
Node.js v18x (or higher)
PM2 (Node Process Manager)

Installing dependencies

To install the dependencies, run the following commands:

composer install

npm install

Environment variables

To set up the environment variables, we need to follow these simple steps:

1. Copy the contents of the .env.example
2. Create a new file called .env, and paste the contents of the .env.example into it.
3. Set up the database information in the .env file.
4. Create a new database with utf8mb4_unicode_ci as a collation.
5. Run php artisan key:generate to generate a new session key for the application.

Do not ever upload the .env file as it contains private credentials.

Running the migration files, database seeds and storage link

To run the migration files and database seeds, run the following commands:

php artisan migrate

php artisan db:seed

php artisan storage:link

Running the application

PRODUCTION

To run the application in production mode, run the following commands:

npm run build

Since we are using ssr (server side rendering), we need to run the following command in the background:

node /bootstrap/ssr/ssr.js

Or we can use this command instead with pm2:

pm2 start /bootstrap/ssr/ssr.mjs --watch

DEVELOPMENT

To run the application in development mode, run the following commands:

npm run build

Since we are using ssr (server side rendering), we need to run the following command in the background:

node /bootstrap/ssr/ssr.mjs

Then we need to run the dev command:

npm run dev

And for the last command we need to run the following command:

php artisan serve