MukeshKapoor25 commited on
Commit
e35abc2
Β·
1 Parent(s): 8ae209b

docs: add README.md with project overview and features

Browse files
Files changed (1) hide show
  1. README.md +32 -0
README.md ADDED
@@ -0,0 +1,32 @@
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
1
+ ---
2
+ title: user-management-service
3
+ emoji: πŸ‘€
4
+ colorFrom: purple
5
+ colorTo: indigo
6
+ sdk: docker
7
+ pinned: false
8
+ ---
9
+
10
+ # User Management Service
11
+
12
+ A FastAPI-based user management service for the BookMyService platform. This service handles user authentication, profile management, and favorite merchants functionality.
13
+
14
+ ## Features
15
+
16
+ - πŸ” User authentication with JWT tokens
17
+ - πŸ“± OTP-based login system
18
+ - πŸ‘€ User profile management
19
+ - ⭐ Favorite merchants management
20
+ - πŸ” Social authentication (Google OAuth)
21
+ - πŸ“§ Email validation
22
+ - πŸ›‘οΈ Security middleware
23
+
24
+ ## API Documentation
25
+
26
+ Once deployed, access the interactive API documentation at:
27
+ - Swagger UI: `/docs`
28
+ - ReDoc: `/redoc`
29
+
30
+ ## Configuration Reference
31
+
32
+ Check out the Hugging Face Spaces configuration reference at https://huggingface.co/docs/hub/spaces-config-reference