Shane-33/workfusion

Falcon Hackathon

# Workfusion 2.0

Workfusion 2.0 is a modern web application for freelancers.

## Table of Contents

- [Installation](#installation)
  - [Prerequisites](#prerequisites)
  - [Clone the Repository](#clone-the-repository)
  - [Install Dependencies](#install-dependencies)
  - [Build the Frontend Assets](#build-the-frontend-assets)
  - [Run the Application](#run-the-application)
- [Usage](#usage)
- [Contributing](#contributing)
- [License](#license)

## Installation

To get a local copy up and running, follow these steps.

### Prerequisites

Ensure you have the following installed:

- [Node.js](https://nodejs.org/)
- [Yarn](https://yarnpkg.com/)
- [Composer](https://getcomposer.org/)
- [PHP](https://www.php.net/)

### Clone the Repository

```sh
git clone https://github.com/feliciien/workfusion2.0.git
cd workfusion2.0

Install Dependencies

Backend

composer install
cp .env.example .env
php artisan key:generate
php artisan migrate:fresh --seed

Configure your .env file as needed for your database and other settings.

Frontend

yarn install

Build the Frontend Assets

yarn dev

Run the Application

php artisan serve

Usage

Open your browser and navigate to http://localhost:8000 to see the application in action.

Contributing

Contributions are what make the open-source community such an amazing place to learn, inspire, and create. Any contributions you make are greatly appreciated.

1. Fork the Project
2. Create your Feature Branch (git checkout -b feature/AmazingFeature)
3. Commit your Changes (git commit -m 'Add some AmazingFeature')
4. Push to the Branch (git push origin feature/AmazingFeature)
5. Open a Pull Request

License

Distributed under the MIT License. See LICENSE for more information.

This format ensures clarity and organization, making it easy for users to follow the installation and usage instructions.