FindPath Project

An ALX Profolio project

Welcome to the FindPath project! FindPath is a navigation application designed to simplify your journeys, providing efficient routes and local exploration. This repository contains the source code and development setup instructions for local deployment.

Stack Used

Laravel: A powerful PHP framework for building web applications.
Tailwind CSS: A utility-first CSS framework for rapidly building custom designs.
HTML, jQuery, JavaScript: Essential web technologies for dynamic and interactive user experiences.
MySQL: A robust relational database for storing and managing data.

Local Development Setup

Using Laragon

Install Laragon: Download and install Laragon for a hassle-free local development environment.

Clone the Repository:

git clone https://github.com/smartraysam/findpath.git

Navigate to Project:
```
cd findpath
```
Install Dependencies:
```
composer install
```
Create Environment File: Duplicate .env.example to .env and configure your database settings.
Generate Application Key:
```
php artisan key:generate
```
Run Migrations and Seed Database:
```
php artisan migrate --seed
```
Start the Development Server:
```
php artisan serve
```
Open in Browser: Visit http://localhost:8000 to see FindPath in action!

Using Docker

Install Docker: Download and install Docker on your machine.

Clone the Repository:

git clone https://github.com/smartraysam/findpath.git

Navigate to Project:
```
cd findpath
```
Create Environment File: Duplicate .env.example to .env and configure your database settings.
Build and Run Docker Containers:
```
docker-compose up -d --build
```

Run Migrations and Seed Database:

docker-compose exec app php artisan migrate --seed

Open in Browser: Visit http://localhost:8000 to see FindPath in action!

Contributing

We welcome contributions to enhance FindPath. Please follow our Contribution Guidelines for more details.

🌐 Explore More: Visit our Profile Landing Page

Happy coding! 🚀