|
1 | | -<p align="center"><a href="https://laravel.com" target="_blank"><img src="https://raw.githubusercontent.com/laravel/art/master/logo-lockup/5%20SVG/2%20CMYK/1%20Full%20Color/laravel-logolockup-cmyk-red.svg" width="400" alt="Laravel Logo"></a></p> |
| 1 | +# 🛡️ PostgreSQL Task Manager (Backend API) |
2 | 2 |
|
3 | | -<p align="center"> |
4 | | -<a href="https://github.com/laravel/framework/actions"><img src="https://github.com/laravel/framework/workflows/tests/badge.svg" alt="Build Status"></a> |
5 | | -<a href="https://packagist.org/packages/laravel/framework"><img src="https://img.shields.io/packagist/dt/laravel/framework" alt="Total Downloads"></a> |
6 | | -<a href="https://packagist.org/packages/laravel/framework"><img src="https://img.shields.io/packagist/v/laravel/framework" alt="Latest Stable Version"></a> |
7 | | -<a href="https://packagist.org/packages/laravel/framework"><img src="https://img.shields.io/packagist/l/laravel/framework" alt="License"></a> |
8 | | -</p> |
| 3 | +This is the **Backend API** for a Task Manager application. It acts as the "Brain" of the project, handling data security, validation, and storage. |
9 | 4 |
|
10 | | -## About Laravel |
| 5 | +It is built with **Laravel 12** and **PostgreSQL** to demonstrate an enterprise-grade database structure (using Foreign Keys and Cascade Deletes). |
11 | 6 |
|
12 | | -Laravel is a web application framework with expressive, elegant syntax. We believe development must be an enjoyable and creative experience to be truly fulfilling. Laravel takes the pain out of development by easing common tasks used in many web projects, such as: |
| 7 | +--- |
13 | 8 |
|
14 | | -- [Simple, fast routing engine](https://laravel.com/docs/routing). |
15 | | -- [Powerful dependency injection container](https://laravel.com/docs/container). |
16 | | -- Multiple back-ends for [session](https://laravel.com/docs/session) and [cache](https://laravel.com/docs/cache) storage. |
17 | | -- Expressive, intuitive [database ORM](https://laravel.com/docs/eloquent). |
18 | | -- Database agnostic [schema migrations](https://laravel.com/docs/migrations). |
19 | | -- [Robust background job processing](https://laravel.com/docs/queues). |
20 | | -- [Real-time event broadcasting](https://laravel.com/docs/broadcasting). |
| 9 | +## 🚀 Architecture |
| 10 | +This project is decoupled (separated) into two parts: |
21 | 11 |
|
22 | | -Laravel is accessible, powerful, and provides tools required for large, robust applications. |
| 12 | +1. **Backend (This Repository):** * **Logic:** Laravel 12 Controllers & Routes |
| 13 | + * **Database:** PostgreSQL 16 |
| 14 | + * **Role:** Provides a REST API (JSON) for the frontend to consume. |
23 | 15 |
|
24 | | -## Learning Laravel |
| 16 | +2. **Frontend (Separate Repository):** |
| 17 | + * **Tech:** HTML + Vanilla JavaScript |
| 18 | + * **Role:** A minimal interface to test the API connection. |
| 19 | + * **🔗 [View the Frontend Repository Here](https://github.com/arivanismail-05/task-client-task-manager)** |
25 | 20 |
|
26 | | -Laravel has the most extensive and thorough [documentation](https://laravel.com/docs) and video tutorial library of all modern web application frameworks, making it a breeze to get started with the framework. You can also check out [Laravel Learn](https://laravel.com/learn), where you will be guided through building a modern Laravel application. |
| 21 | +--- |
27 | 22 |
|
28 | | -If you don't feel like reading, [Laracasts](https://laracasts.com) can help. Laracasts contains thousands of video tutorials on a range of topics including Laravel, modern PHP, unit testing, and JavaScript. Boost your skills by digging into our comprehensive video library. |
| 23 | +## 🛠️ Tech Stack (Backend) |
| 24 | +* **Framework:** Laravel 12 |
| 25 | +* **Database:** PostgreSQL (Connection via `pgsql` driver) |
| 26 | +* **API Style:** RESTful JSON |
| 27 | +* **Server:** Apache/Nginx (Local Development via Laragon/XAMPP) |
29 | 28 |
|
30 | | -## Laravel Sponsors |
| 29 | +--- |
31 | 30 |
|
32 | | -We would like to extend our thanks to the following sponsors for funding Laravel development. If you are interested in becoming a sponsor, please visit the [Laravel Partners program](https://partners.laravel.com). |
| 31 | +## ⚙️ How to Run This Backend |
33 | 32 |
|
34 | | -### Premium Partners |
| 33 | +1. **Clone the Repo** |
| 34 | + ```bash |
| 35 | + git clone [https://github.com/arivanismail-05/task-manager.git](https://github.com/arivanismail-05/task-manager.git) |
| 36 | + cd task-manager |
| 37 | + ``` |
35 | 38 |
|
36 | | -- **[Vehikl](https://vehikl.com)** |
37 | | -- **[Tighten Co.](https://tighten.co)** |
38 | | -- **[Kirschbaum Development Group](https://kirschbaumdevelopment.com)** |
39 | | -- **[64 Robots](https://64robots.com)** |
40 | | -- **[Curotec](https://www.curotec.com/services/technologies/laravel)** |
41 | | -- **[DevSquad](https://devsquad.com/hire-laravel-developers)** |
42 | | -- **[Redberry](https://redberry.international/laravel-development)** |
43 | | -- **[Active Logic](https://activelogic.com)** |
| 39 | +2. **Setup Database** |
| 40 | + * Ensure PostgreSQL is running. |
| 41 | + * Create a database named `task_manager`. |
| 42 | + * Update your `.env` file with your DB credentials. |
44 | 43 |
|
45 | | -## Contributing |
| 44 | +3. **Install & Migrate** |
| 45 | + ```bash |
| 46 | + composer install |
| 47 | + php artisan migrate |
| 48 | + ``` |
46 | 49 |
|
47 | | -Thank you for considering contributing to the Laravel framework! The contribution guide can be found in the [Laravel documentation](https://laravel.com/docs/contributions). |
| 50 | +4. **Start Server** |
| 51 | + ```bash |
| 52 | + php artisan serve |
| 53 | + ``` |
| 54 | + The API will be live at: `http://127.0.0.1:8000/api` |
48 | 55 |
|
49 | | -## Code of Conduct |
| 56 | +--- |
50 | 57 |
|
51 | | -In order to ensure that the Laravel community is welcoming to all, please review and abide by the [Code of Conduct](https://laravel.com/docs/contributions#code-of-conduct). |
| 58 | +## 📝 API Endpoints |
| 59 | +These are the routes available for the frontend to use: |
52 | 60 |
|
53 | | -## Security Vulnerabilities |
| 61 | +| Method | Endpoint | Action | |
| 62 | +| :--- | :--- | :--- | |
| 63 | +| `GET` | `/api/categories` | Get all categories | |
| 64 | +| `POST` | `/api/categories` | Create a new category | |
| 65 | +| `DELETE` | `/api/categories/{id}` | Delete a category (and its tasks) | |
| 66 | +| `GET` | `/api/tasks` | Get all tasks | |
| 67 | +| `POST` | `/api/tasks` | Create a new task | |
| 68 | +| `PUT` | `/api/tasks/{id}` | Update task (e.g., mark as done) | |
54 | 69 |
|
55 | | -If you discover a security vulnerability within Laravel, please send an e-mail to Taylor Otwell via [taylor@laravel.com](mailto:taylor@laravel.com). All security vulnerabilities will be promptly addressed. |
| 70 | +--- |
56 | 71 |
|
57 | | -## License |
| 72 | +## 💡 Note to Visitors & Challenges |
58 | 73 |
|
59 | | -The Laravel framework is open-sourced software licensed under the [MIT license](https://opensource.org/licenses/MIT). |
| 74 | +This project serves as a **Backend Foundation**. I have intentionally kept the Frontend simple (Plain HTML/JS) to focus on the Backend logic. |
| 75 | + |
| 76 | +**How to use this:** |
| 77 | +1. Run this backend server. |
| 78 | +2. Open the linked Frontend repository (`index.html`) to interact with the app. |
| 79 | + |
| 80 | +**Challenges for You:** |
| 81 | +I invite you to fork this repo and improve it: |
| 82 | +* **Add Design:** The current frontend has no CSS. Feel free to add Tailwind, Bootstrap, or your own custom design to make it look professional. |
| 83 | +* **Implement Features:** The Backend includes API routes for `Update` (PUT) and `Delete` (DELETE). Can you add buttons in the frontend to trigger these? |
| 84 | +* **Architecture:** Try replacing the HTML frontend with a React or Vue.js application. |
0 commit comments