Add comprehensive project documentation for ClinicPro in CLAUDE.md and README.md
- Introduced CLAUDE.md for internal guidance on project structure, commands, and architecture. - Created README.md with detailed project overview, technology stack, directory structure, setup instructions, API endpoints, authentication flow, and external services.
This commit is contained in:
@@ -12,8 +12,11 @@ nelmio_api_doc:
|
||||
bearerFormat: JWT
|
||||
security:
|
||||
- bearerAuth: []
|
||||
html_config:
|
||||
assets_mode: bundle
|
||||
areas:
|
||||
path_patterns:
|
||||
- ^/api
|
||||
- ^/oauth
|
||||
- ^/health
|
||||
default:
|
||||
path_patterns:
|
||||
- ^/api
|
||||
- ^/oauth
|
||||
- ^/health
|
||||
|
||||
@@ -2,12 +2,20 @@ security:
|
||||
password_hashers:
|
||||
App\Auth\Entity\User:
|
||||
algorithm: auto
|
||||
Symfony\Component\Security\Core\User\InMemoryUser:
|
||||
algorithm: bcrypt
|
||||
|
||||
providers:
|
||||
app_user_provider:
|
||||
entity:
|
||||
class: App\Auth\Entity\User
|
||||
property: mobileNumber
|
||||
api_doc_provider:
|
||||
memory:
|
||||
users:
|
||||
'%env(API_DOC_USERNAME)%':
|
||||
password: '%env(API_DOC_PASSWORD)%'
|
||||
roles: ['ROLE_ADMIN']
|
||||
|
||||
firewalls:
|
||||
dev:
|
||||
@@ -18,6 +26,12 @@ security:
|
||||
pattern: ^/health$
|
||||
security: false
|
||||
|
||||
api_doc:
|
||||
pattern: ^/api/doc
|
||||
http_basic:
|
||||
realm: "ClinicPro API Documentation"
|
||||
provider: api_doc_provider
|
||||
|
||||
public_endpoints:
|
||||
pattern: ^/(api/v1/user/(send-code|verify-code|register)|oauth/token$|session/token|api/v1/categorys/|api/v1/doctors$|api/v1/clinics$|api/v1/clinic/doctor-list/|api/v1/clinic-pro/doctor-addresses/|api/v1/appointment-slots|api/v1/comments/|api/v1/rate/|api/v1/blogs$)
|
||||
stateless: true
|
||||
@@ -38,6 +52,7 @@ security:
|
||||
|
||||
access_control:
|
||||
- { path: ^/health$, roles: PUBLIC_ACCESS }
|
||||
- { path: ^/api/doc, roles: ROLE_ADMIN }
|
||||
- { path: ^/api/v1/user/send-code, roles: PUBLIC_ACCESS }
|
||||
- { path: ^/api/v1/user/verify-code, roles: PUBLIC_ACCESS }
|
||||
- { path: ^/api/v1/user/register, roles: PUBLIC_ACCESS }
|
||||
@@ -54,15 +69,14 @@ security:
|
||||
- { path: ^/session/token, roles: PUBLIC_ACCESS }
|
||||
- { path: ^/api/v1/payment/callback/, roles: PUBLIC_ACCESS }
|
||||
- { path: ^/api/v1/subscription-payment/callback/, roles: PUBLIC_ACCESS }
|
||||
- { path: ^/api/doc, roles: PUBLIC_ACCESS }
|
||||
- { path: ^/api/v1/categorys/, roles: PUBLIC_ACCESS }
|
||||
- { path: ^/api/v1/doctors$, roles: PUBLIC_ACCESS }
|
||||
- { path: ^/api/v1/categorys/, roles: PUBLIC_ACCESS }
|
||||
- { path: ^/api/v1/doctors$, roles: PUBLIC_ACCESS }
|
||||
- path: '^/api/v1/doctor/[^/]+$'
|
||||
methods: [GET]
|
||||
roles: PUBLIC_ACCESS
|
||||
- { path: ^/api/v1/clinic/doctor-list/, roles: PUBLIC_ACCESS }
|
||||
- { path: ^/api/v1/clinic-pro/doctor-addresses/, roles: PUBLIC_ACCESS }
|
||||
- { path: ^/api/v1/clinics$, roles: PUBLIC_ACCESS }
|
||||
- { path: ^/api/v1/clinic/doctor-list/, roles: PUBLIC_ACCESS }
|
||||
- { path: ^/api/v1/clinic-pro/doctor-addresses/, roles: PUBLIC_ACCESS }
|
||||
- { path: ^/api/v1/clinics$, roles: PUBLIC_ACCESS }
|
||||
- path: '^/api/v1/clinic/[^/]+$'
|
||||
methods: [GET]
|
||||
roles: PUBLIC_ACCESS
|
||||
|
||||
Reference in New Issue
Block a user