PalWeb: the Web of Palestinian Arabic

PalWeb is the online hub for the study & research of the Palestinian dialects of Spoken Arabic. This README will only discuss how to get your clone of the application up & running. You can refer to ...

• PalWeb | Wiki: About for general information about the project;
• PalWeb | Wiki: User Guide for information about the sections, content & features of the site;
• PalWeb | Wiki: Contributing for technical information about the application & our current tasks.

If you'd like to contribute to the project, here's how you can get set up:

Setting Up

Fork the repository via GitHub, then clone your fork.

git clone [email protected]:username/PalWeb.git

Make sure to add the upstream repository.

git remote add upstream [email protected]:PalWeb-Online/PalWeb.git

PalWeb is a Laravel application that uses Laravel Sail to easily manage Docker containers. While the Docker container will automatically include the PHP & MySQL versions used by the application, you need to at least have PHP & its package manager Composer installed to run Sail. It's best to go for the latest versions on the host machine, as otherwise you may not meet the application's PHP version requirements.

You will also need Node.js installed to run Vite, an asset bundler, to compile Sass & Vue files.

On macOS (using Homebrew):

brew install php

brew install composer

brew install node

Once that's done, install the application's dependencies, including Laravel Sail (via Composer).

composer install

npm install

Now, install & run the Docker container. (Make sure you have Docker Desktop on your machine.) Sail will ask which services you want to enable; select MySQL.

php artisan sail:install

Once Sail is installed, you're no longer dependent on the host machine for running Laravel commands. Use Sail (./vendor/bin/sail, or configure an alias) to manage the app in Docker.

Start the app with the up command. (Use the -d option to run it in the background.)

sail up -d

You will now need to run the database migrations & the seeders that will populate the database with dummy data. You will be asked to create the database palweb; confirm.

sail artisan migrate:fresh --seed

Finally, run the Vite development server.

npm run dev

Navigate to localhost in your web browser & you should now see your very own local version of PalWeb!