README.md

Taskato

A simple Laravel application to allow users to create group or list and add task for doing and self scheduling.

Contents

• Requirements
• Getting Started
  • Installation
  • Configuration
  • Assets
  • Run the Project
  • All Commands
• Testing
• Roadmap
• Contributing
• Built With
• License

Requirements

• PHP 8.1 or higher
• Database (eg: MySQL, PostgreSQL, SQLite)
• Web Server (eg: Apache, Nginx, IIS or use Laragon)
• Composer
• Node.js
• Yarn (optional)

Getting Started

Installation

Clone the repository and switch to the repo folder using the following command:

git clone [email protected]:sadegh19b/taskato.git
cd taskato

Install the php dependencies using composer:

composer install

Install the node dependencies:

• using npm command

  npm install

• using yarn command

  yarn

Configuration

Copy the example environment (.env.example) file and configuration your change want in the .env file:

cp .env.example .env

Generate a new application key:

php artisan key:generate

Run the database migrations:

• Before run below command, create a database in mysql and configure the .env file mysql settings according to your system.
• If you want the database with fake data, add the --seed parameter to the end of the command below.

php artisan migrate

Assets

Compile assets if you want work in development mode:

• using npm command

  npm run dev

• using yarn command

  yarn dev

Compile assets for production:

• using npm command

  npm run build

• using yarn command

  yarn build

Run

Run the project in the dev server (the output will give the address):

php artisan serve

All Commands

git clone [email protected]:sadegh19b/taskato.git
cd taskato
composer install
cp .env.example .env
php artisan key:generate
php artisan migrate --seed
yarn
yarn build

Testing

php artisan test

Roadmap

• Endpoint & logic tests
• Validation tests
• End-to-end tests (browser tests)
• Add confirm modal component in svelte
• Add details modal component for show todo
• Add toast component for show message after save, update, delete or in error case
• Add pagination for todos, load more after scroll down
• Add custom scrollbar
• Responsive design
• PWA
• Multi-languages [FA, EN]

Contributing

1. Clone the repo and create a new branch: git checkout [email protected]:sadegh19b/taskato.git -b name_for_new_branch
2. Make changes and test
3. Submit Pull Request with comprehensive description of changes

Built With

This software uses the following open source packages:

• Laravel
• Verta
• Sortable Eloquent
• Ziggy
• Inertia.js
• Svelte
• TailwindCSS
• daisyUI

License

Taskato is open source software released under the MIT license. See LICENSE for more information.