Skip to content

Repository files navigation

Project Setup Guide

This guide provides step-by-step instructions to set up and run the project on MacOS and Windows.


📌 Prerequisites

Before starting, ensure you have the following installed:

MongoDB (Download & Install)
Composer (Download & Install)
Node.js & NPM (Download & Install)
PHP 8+ (Download & Install)
Laravel Valet (MacOS only) (Installation Guide)


📌 Installation Steps

🔹 1. Clone the Repository

git clone https://github.com/rafcy/test-LW.git
cd your-repository

🔹 2. Install Dependencies

Run the following command to install PHP and NPM dependencies:

composer install
npm ci

🔹 3. Create .env File

Copy the .env.example file and update it:

cp .env.example .env

Modify the Mailchimp and/or MongoDB database variables to yours.

🔹 4. Generate Application Key

php artisan key:generate

🔹 5. Set Up MongoDB

Make sure MongoDB is running before proceeding.

For MacOS, you can start MongoDB using:

brew services start mongodb-community

For Windows, open MongoDB Compass or run:

mongod --dbpath="C:\data\db"

📌 Database Setup

🔹 6. Run Migrations

php artisan migrate

📌 Running the Application

🔹 Option 1: Using Laravel Valet (MacOS)

valet link project-name
valet secure

Visit: https://project-name.test

🔹 Option 2: Using PHP Built-in Server

php artisan serve

Visit: http://127.0.0.1:8000

🔹 7. Start Vite for Frontend Development

npm run dev

**📌 Application Demo **

If you would like to watch the functionalities of the website, please watch the following demo.

Video Demo

📌 Additional Commands

🔹 Running Tests

To run PHPUnit tests:

php artisan test

About

No description, website, or topics provided.

Resources

Stars

0 stars

Watchers

1 watching

Forks

Releases

Packages

Contributors

Languages