Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/bukarinevg/task-planner
Task management tool
https://github.com/bukarinevg/task-planner
Last synced: 17 days ago
JSON representation
Task management tool
- Host: GitHub
- URL: https://github.com/bukarinevg/task-planner
- Owner: bukarinevg
- License: apache-2.0
- Created: 2023-11-23T20:49:20.000Z (about 1 year ago)
- Default Branch: main
- Last Pushed: 2024-01-24T02:34:58.000Z (about 1 year ago)
- Last Synced: 2024-01-24T21:58:53.396Z (about 1 year ago)
- Language: PHP
- Size: 56.6 KB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: readme.md
- License: LICENSE
Awesome Lists containing this project
README
# Task Planner
## Introduction
This is a task planner application that add string to the table tickets,
after number of minutes the string will be moved to ticket table.
## Features
- Create row in a table in n minutes.
- In project used PHP-8, MVC pattern, Rest API, Cron, Docker, Apache, MySQL, Composer,
OOP, SOLID principles, PSR-4 for autoloading and PSR-7 symphony class for handling request.
## Installation
1. Clone the repository.
2. Run the following command to install the dependencies:
```bash
composer install
```
3. Docker is required to run the application. If you don't have Docker installed,
you can download it [here](https://www.docker.com/products/docker-desktop).
4. Run the following command to build the Docker image:
```bash
docker-compose up --build
```
## Usage
1. The main url is http://localhost:8080
2. Send request with POST, GET to http://localhost:8080 with body:
```json
{
"code": "string",
"min": number
}
```
3. In n-minutes the string will be moved to ticket table.
4. PHPMyAdmin is available at http://localhost:8888 with username `root` and password `root`.
## Project Structure
- `config/` - This directory contains configuration file.
- `db/` - This directory contains migrations.
- `php-apache/` - This directory contains Dockerfile for Apache.
- `php-fpm/` - This directory contains Dockerfile for PHP.
- `src/` - This directory contains the main application code.
- `controllers/` - This directory contains the controller classes.
- `models/` - This directory contains the model classes.
- `source/` - Base code of application.
- `controller/` - This directory contains Abstract Controller Class.
- `model/` - This directory contains Abstract Model Class.
- `db/` - This directory contains DataBase settings Classes.
- `connectors/` - This directory contains DBConnectionInterface connectors Classes.
- `http/` - This directory contains Request Handler Classes.
- `vendor/` - This directory contains the Composer dependencies.
- `index.php` - This file is the entry point of the application.
- `composer.json` - This file is used to manage the dependencies of the project.
- `docker-compose.yml` - This file is used to configure Docker for the project.
- `phpinx.php` - This file is used to run migrations.
- `gitignore` - This file tells Git which files to ignore.
- `scheduler.php` - This file is used to run cron job.
- `script.php` - The main script that used by cron job.
- `readme.md` - This file contains the documentation of the project.
- `LICENSE` - This file contains the license information of the project.
## Database
Tickets are string that added with api.
Table `tickets` contains 3 columns:
- `id` - The primary key of the table.
- `code` - The string that was added to the table.
- `created_at` - The date and time when the string was added to the table.
Table `tasks` perfoms buffer between api and tickets table.
Table `tasks` contains 3 columns:
- `id` - The primary key of the table.
- `code` - The string that was added to the table.
- `created_at` - The date and time when the string was added to the table.
- `time_to_run` - The date and time when the string will be moved to ticket table.
To run queries, you can use classes that inheritad from the class `AbstaractModel`.
The child class must have a property `$table` with the name of the table.
The child class may have method `validate()` that validate data before insert to table, it takes inserting data as argument, return true if data validated.]
In charge of connection and running queries is the class `DataBase`.
That class is called by AbrstaractModel child classes when there is need to run query.
Log
## Contributing
Contributions are welcome! Please follow the guidelines in [CONTRIBUTING.md](./CONTRIBUTING.md) to contribute to this project.
## License
This project is licensed under the [Apache](./LICENSE).