Task Management App

This repository contains a task management application built with Laravel for the backend API, Vue.js for the frontend client, and Tailwind CSS for styling. The application includes API endpoints for managing tasks and user authentication.

Prerequisites

• PHP >= 8.0
• Composer
• Node.js and npm
• MySQL or any other database supported by Laravel

Installation

Clone the repository

git clone https://github.com/Diegojas/task-manager.git
cd task-manager

Set up Laravel Backend

1. Install PHP dependencies:

composer install

2. Copy .env.example to .env and fill in your environment details, including the database connection and any other configurations:

cp .env.example .env

3. Generate application key:

php artisan key:generate

4. Run database migrations and seeders:

php artisan migrate --seed

5. Start the Laravel development server:

php artisan serve

Set up Vue.js Frontend

Navigate to the vue-client directory inside the Laravel project:

cd vue-client

1. Install JavaScript dependencies:

npm install

2. Compile and hot-reload for development:

npm run dev

3. Build for production:

npm run build

For more details on Vue.js setup, refer to the vue-client/README.md file.

API Documentation

To access the API documentation, generated by Scribe, start the Laravel development server and visit:

http://YOUR_ENDPOINT/docs

This will show you a detailed description of all available API endpoints including headers, parameters, request/response examples, etc.

Running Tests

Before running tests, create a separate environment for tests. You can do that by creating .env.testing.

To run PHPUnit tests for the entire application, use the following command:

php artisan test

Contributing

If you would like to contribute to this project, please follow these steps:

1. Fork the repository
2. Create a 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

Please follow the PSR-12 coding standard and ensure all tests pass before making a pull request.

Thank you for considering contributing to this project!

License

This project is open source and available under the MIT License.