taskARR

taskARR is a versatile Laravel application designed to assist in task management, decision-making, and various other functionalities, catering to both work and leisure activities.

About taskARR

taskARR isn't just about managing tasks; it's an ecosystem aiding in optimizing time between work and relaxation. It offers features for tasks, movie and music recommendations, reviews, and a blog, fostering a balanced lifestyle.

Usage Overview

Here's what you can do with taskARR:

• Upon Landing: When you first land on taskARR, you'll see suggested activities for the day based on people preferences and available time. (Only for login user)
• Dashboard: After login, the dashboard presents personalized activity suggestions tailored to your behavior and the time of day.
• Modules: Access different modules like Movies, Music, Tasks, and more from the dashboard to explore various activities.

Using taskARR

1. Landing Page: See recommended activities on the landing page before logging in.
2. Login: Access your personalized dashboard by logging in.
3. Dashboard: Find suggested activities based on your behavior and time.
4. Explore Modules:
   • Movies: Discover movies with public or private visibility (admin approval required for private submissions).
   • Music: Explore music recommendations with public or private visibility (admin approval required for private submissions).
   In progress...

Modules

Core

• Authentication Module: Handles user authentication and access control.
• Dashboard Module: Provides an overview and quick access to essential features.
• QR Code Module: Enables the generation and scanning of QR codes.
• PDF Module: Facilitates the creation and manipulation of PDF documents.
• API Module: Offers an interface for integration with external systems through APIs.
• WebSocket Module: Implements real-time communication via WebSocket technology.
• Notification Module: Manages and dispatches notifications to users.
• Settings Module: Controls and customizes application settings.
• Payment Module: Facilitates payment processing within the application.
• Jobs Module: Handles background job processing and scheduling.

Functional

• Movie Module: Provides features related to movie recommendations, ratings, and comments.
• Review Module: Enables users to rate and review various entities within the app.
• Calendar Module: Manages scheduling and event organization.
• Calendar API (Google + Apple): Integrates with Google and Apple calendars for seamless synchronization.
• User Module: Manages user-related functionalities.
• Admin Module: Provides administrative functionalities and controls.

Additional

• Permission Module: Controls access and permissions for different user roles.
• Shop Module: Facilitates online shopping functionalities.
• Document Module: Manages document storage and handling.
• Reports Module: Generates and presents reports based on application data.
• Integration Module: Handles integrations with external services and APIs.
• Blog Module: Offers a platform for blog creation and interaction.
• Forum Module: Enables discussions and community engagement.
• Chat Module: Implements real-time chat features.

Requirements

Make sure your environment meets the following requirements:

• PHP 8.1+
• Laravel 10
• Docker installed on your machine

Installation with Docker

To install and run taskARR using Docker on your local machine, follow these steps:

Don't know what's it is docker? Containerization software!

- https://laravel.com/docs/10.x#docker-installation-using-sail

- https://www.docker.com/products/docker-desktop/

1. Clone the repository:
git clone https://github.com/dbetlej/taskARR
2. Navigate to the project directory:
cd taskARR
3. Copy the example environment file and configure:
cp .env.example .env

Update the .env file with your database credentials and any other necessary configuration.

4. Build and start the Docker containers - choose one below:

No matter do You use docker-compose or docker compose.

docker-compose up -d --build

*in background

docker compose up --build

*not in background

This command will build the necessary Docker containers specified in docker-compose.yml and start them in detached mode.

5. Generate application key:
docker-compose exec laravel-test bash php artisan key:generate

Or get on localhost and click button "Generate App Key"

6. Run migrations:
docker-compose exec laravel-test bash php artisan migrate
7. Start and stop the application in Docker:
docker-compose start docker-compose stop

This command starts the Laravel server inside the Docker container, allowing access at http://localhost:8000 on your local machine.

8. Run npm run dev:
npm run dev

This command compiles the frontend assets using npm inside the Docker container.

Contributing

I welcome contributions to enhance taskARR! If you'd like to contribute:

1. Fork the repository: Fork the taskARR repository on GitHub.
2. Create branches for features: Create a branch for each feature or improvement you're working on.
3. Make commits: Make commits with descriptive messages for each change.
4. Submit pull requests for review: Once you've made changes, submit a pull request for review.

I appreciate your contributions in making taskARR even better!

License

In progress...

Acknowledgments

In progress...