Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/ronald-kimeli/task-management-api
Task Management API on Laravel
https://github.com/ronald-kimeli/task-management-api
laravel task-management task-management-api task-manager
Last synced: 21 days ago
JSON representation
Task Management API on Laravel
- Host: GitHub
- URL: https://github.com/ronald-kimeli/task-management-api
- Owner: ronald-kimeli
- Created: 2024-09-09T20:31:28.000Z (4 months ago)
- Default Branch: master
- Last Pushed: 2024-09-10T06:57:24.000Z (4 months ago)
- Last Synced: 2024-10-31T05:22:44.632Z (2 months ago)
- Topics: laravel, task-management, task-management-api, task-manager
- Language: PHP
- Homepage:
- Size: 681 KB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
Task Management API
==========================
This is a task management API based on laravel API, basically a user can add category (e.g New Feature) and Task for management.
Table of Contents
-----------------
* [Requirements](#requirements)
* [Features](#features)
* [Installation](#installation)
* [Usage](#usage)
* [Database Overview](#database-overview)
Requirements
------------
* [PHP 8.2+][php]
* [Laravel 11][laravel]
* [PostgreSQL][postgresql]
* [Node.js][node] 16+
* [Vite][vite]
* [Postman][postman]
[php]: https://www.php.net/releases/
[laravel]: https://laravel.com/docs/11.x/installation
[postgresql]: https://www.postgresql.org/
[node]: https://nodejs.org
[vite]: https://vitejs.dev
[postman]: https://www.postman.com/
Features
--------
- Create, get all, get a specific, update, delete a Task(s).
- Data validation from the incoming requests using custom requests.
- Task search with their titles, status, due_date.
- Paginated data in pages of 10 each.
- Eloquent relationships and controller responses.
Installation
------------
Create .env file through copy
```bash
cp .env.example .env
```
Provide database credentials below in .env file for postgres.
```php
DB_CONNECTION=pgsql
DB_HOST=127.0.0.1
DB_PORT=5432
DB_DATABASE=Enter_database_name
DB_USERNAME=Enter_database_user_name
DB_PASSWORD=Enter_database_password
```
Install project dependencies, key generate and clear cached config
```php
composer install && php artisan key:generate && php artisan optimize
```
Now seed db with dummy data and start the server.
```php
php artisan migrate --seed && php artisan serve
```
Install nodejs dependencies and run the server
```javascript
npm install && npm run dev
```
Laravel will run on port 8000 and node most likely 5173 or 3000
```php
localhost:8000 || localhost:5173
```
Database Overview
-----------------
Usage
------------
For testing api endpoints, once postman installed navigate to import and upload provided `Task_Management_Assignment API.postman_collection.json` inside this project then follow next steps.
## Postman configuration
!All api endpoints should have /api/v1/. [http://127.0.0.1:8000/api/v1] !> Note that there is two main folders (public routes - no authentication needed and protected routes)
>Protected routes start with either Login or Register then copy token for authorizing these requests
>Paste the token as Bearer token for usage as shown below
>Finaly, make a request
