Skip to content

Latest commit

 

History

History
44 lines (32 loc) · 1.3 KB

start.md

File metadata and controls

44 lines (32 loc) · 1.3 KB
Raw

Getting Started

System Requirements

  • PHP 8.1+
  • Node 18.12.1+
  • MySQL 8.0+

Packages Used

Initial Setup

Once the reposoitory has been installed on your local machine you need to get a few things setup:

composer install  (only needed if you directly downloaded the files)
npm install
php spark migrate --all
php spark db:seed SampleDataSeeder  (only if you want sample forums, users, etc created)

Frontend Development

We use ParcelJS to handle compiling the frontend assets, including SASS and Javascript. When working on frontend code, ensure you have parcel running:

npm run dev

Sending emails

Setup some Email Sandbox. Provide credentials - preferably using the .env file. Don't forget to set up fromEmail and fromName variables too, because without them emails won't be sent.