-
Notifications
You must be signed in to change notification settings - Fork 0
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Merge pull request #1 from jordimorillo/jordimorillo-patch-1
Update readme.md
- Loading branch information
Showing
1 changed file
with
2 additions
and
38 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,38 +1,2 @@ | ||
# Slim Microservice Skeleton | ||
This project skeleton uses the Slim PHP framework and is designed to support MySQL, following a modular hexagonal architecture with CQRS and events. | ||
|
||
## Installation | ||
To create a new project using this skeleton, run the following command: | ||
|
||
|
||
|
||
```bash | ||
composer create-project jordimorillo/slim-microservice-skeleton my_project_directory | ||
``` | ||
|
||
Make sure to replace my_project_directory with your preferred project directory name. | ||
|
||
|
||
## Requirements | ||
Ensure Composer is installed before running the installation command. | ||
|
||
|
||
## Configuration | ||
Database: Configure your MySQL connection details in the .env file by copying it from .env.example. | ||
|
||
|
||
Routes: The routes file is located at /configuration/routes.php. | ||
|
||
|
||
|
||
## Usage | ||
This skeleton is designed to facilitate microservices development using Slim and a hexagonal architecture with CQRS and events. Follows best practices for clean and structured development. | ||
|
||
|
||
|
||
## License | ||
This project is distributed under the MIT license. Full details in LICENSE. | ||
|
||
|
||
|
||
|
||
# User Project | ||
This project uses Slim PHP framework with PHP and MySQL to serve a basic REST API for a user entity. Encoding and decoding of the user's password is done by default encryption method set in PHP. |