Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/jvzaniolo/client-manager
A simple client manager built with pure PHP
https://github.com/jvzaniolo/client-manager
docker mysql php tailwindcss
Last synced: 10 days ago
JSON representation
A simple client manager built with pure PHP
- Host: GitHub
- URL: https://github.com/jvzaniolo/client-manager
- Owner: jvzaniolo
- Created: 2024-03-15T14:07:51.000Z (8 months ago)
- Default Branch: main
- Last Pushed: 2024-03-23T14:32:24.000Z (8 months ago)
- Last Synced: 2024-03-24T00:38:40.048Z (8 months ago)
- Topics: docker, mysql, php, tailwindcss
- Language: PHP
- Homepage:
- Size: 67.4 KB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# Client Manager
This is a full-stack application built with PHP and MySQL. It is a simple client manager that allows you to add, edit, and delete clients and their addresses.
## What I learned
There aren't a lot of recent resources online when it comes to using pure PHP in 2024, so I wrote a blog post sharing the things I learned.
## Overview
The application has the following structure:
- `public/index.php` is the application's entry point, where the autoloader is required and the application is started.
- `src/Core` contains the application core, such as implementing the Router, Database, Renderer, etc.
- `src/Handlers` contains the request handlers for the application routes.
- `GET` requests call the handler `loader` method if it exists
- `POST` requests call the `action` method if it exists.
- Handlers can also have a `render` method to render the HTML template.
- `src/Middleware` contains the middleware classes such as `Auth` and `Guest` middlewares for protected routes.
- `src/templates` contains the HTML templates rendered with Plates.
- `src/routes.php` registers the application routes and their handlers.
- `src/utils.php` contains helper functions like `dd` for debugging.
## Running with Docker
1. Make sure you have Docker installed:
```
docker -v
```
2. Start the application and the database with Docker Compose:
```
docker-compose up -d
```
3. Open your browser and navigate to http://localhost:8888.
You can log in with the following credentials:
```
Email: [email protected]
Password: 123456
```
## Running locally
1. Make sure you have PHP 8.\*, Composer, and Docker installed:
```
php -v
composer -v
docker -v
```
2. Install the dependencies:
```
composer install
```
3. Start the database with Docker Compose:
```
docker-compose up -d db
```
This command will start a MySQL database on port :3306.
You can also use a local version of MySQL, just make sure to update the `.env` file with your database credentials.
4. Start the application:
```
composer start
```
This command will copy the `.env.example` file to `.env` and start the PHP built-in server.
5. Open your browser and navigate to http://localhost:8888.
You can log in with the following credentials:
```
Email: [email protected]
Password: 123456
```
## Cleaning up Docker
To stop the Docker containers, run:
```
docker-compose down -v --rmi all
```
This will stop the containers, remove the volumes, and delete the images.
---
Made with 🧡 by @jvzaniolo