Skip to content

Commit

Permalink
Merge pull request #1 from jordimorillo/jordimorillo-patch-1
Browse files Browse the repository at this point in the history
Update readme.md
  • Loading branch information
jordimorillo committed Mar 19, 2024
2 parents 88a277b + fc70789 commit e4da7f5
Showing 1 changed file with 2 additions and 38 deletions.
40 changes: 2 additions & 38 deletions readme.md
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.

0 comments on commit e4da7f5

Please sign in to comment.