Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/abbasfisal/appointment-app
php pure web application with hexagonal architecture
https://github.com/abbasfisal/appointment-app
hexagonal php php8 swagger swagger-ui
Last synced: 11 days ago
JSON representation
php pure web application with hexagonal architecture
- Host: GitHub
- URL: https://github.com/abbasfisal/appointment-app
- Owner: abbasfisal
- Created: 2024-06-20T04:49:02.000Z (7 months ago)
- Default Branch: main
- Last Pushed: 2024-06-20T06:36:26.000Z (7 months ago)
- Last Synced: 2024-11-07T23:29:23.876Z (2 months ago)
- Topics: hexagonal, php, php8, swagger, swagger-ui
- Language: JavaScript
- Homepage:
- Size: 3.38 MB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
## Appointment Project
Run below Commands:
1. copy the `.env.example` file to `.env`:
```bash
cp .env.example .env
```
2. build and run the project using Docker:
```bash
docker-compose up --build
```
3. Install the composer packages
```bash
make composer-install
```
4. Migrate and seed tables
```bash
make migrate
```
5. #### Run Swagger Documentation http://localhost:8081/doc/
Note: If the port or host address changes (e.g., from `localhost` to `127.0.0.1` or any other host address),
you must update it in `doc/index.html`.
```
window.onload = function() {
SwaggerUIBundle({
url: "http://localhost:8081/doc/swagger.php",
dom_id: '#swagger-ui',
presets: [
SwaggerUIBundle.presets.apis,
SwaggerUIStandalonePreset
],
layout: "BaseLayout",
deepLinking: true
})
}
```
___
- #### Run Tests
```bash
make run-test
```
___
## routes
| # | url | method | description |
|:---:|:--------------------:|:------:|:-----------------------------------:|
| 1 | /appointments | GET | Get list of Appointments |
| 1 | /appointments/create | POST | Create New Appointment for the user |
| 1 | /appointments/cancel | PATCH | Cancel an Appointment |