Spaces:
Runtime error
Runtime error
|
Download README.md from adwhytahumans/CRM_FastAPI_React: direct link, hf CLI and curl.
- Browser
- Download file 1.47 kB
-
https://huggingface.co/spaces/adwhytahumans/CRM_FastAPI_React/resolve/main/README.md
- Command line
-
hf download hf://spaces/adwhytahumans/CRM_FastAPI_React/README.md
-
curl -L -o README.md https://huggingface.co/spaces/adwhytahumans/CRM_FastAPI_React/resolve/main/README.md
1.47 kB
| title: CRM FastAPI React | |
| emoji: 🌖 | |
| colorFrom: gray | |
| colorTo: gray | |
| sdk: docker | |
| pinned: false | |
| Check out the configuration reference at https://huggingface.co/docs/hub/spaces-config-reference | |
| # 100x Elite CRM System | |
| A simple CRM system for managing learner enrollments in 100x Elite courses. | |
| ## Setup | |
| 1. Create a virtual environment (recommended): | |
| ```bash | |
| python -m venv venv | |
| source venv/bin/activate # On Windows: venv\Scripts\activate | |
| ``` | |
| 2. Install dependencies: | |
| ```bash | |
| pip install -r requirements.txt | |
| ``` | |
| 3. Run the application: | |
| ```bash | |
| python app.py | |
| ``` | |
| The server will start at `http://localhost:8000` | |
| ## API Documentation | |
| Once the server is running, you can access: | |
| - Interactive API documentation: `http://localhost:8000/docs` | |
| - Alternative API documentation: `http://localhost:8000/redoc` | |
| ## API Endpoints | |
| 1. Create a new learner: | |
| - POST `/learners` | |
| - Body example: | |
| ```json | |
| { | |
| "name": "John Doe", | |
| "email": "john@example.com", | |
| "phone": "+1234567890", | |
| "course": "AI Filmmaking" | |
| } | |
| ``` | |
| 2. Get all learners: | |
| - GET `/learners` | |
| 3. Update a learner: | |
| - PUT `/learners/{learner_id}` | |
| - Body: Same as create learner | |
| 4. Delete a learner: | |
| - DELETE `/learners/{learner_id}` | |
| ## Testing with Postman | |
| 1. Import the following collection into Postman: | |
| - Base URL: `http://localhost:8000` | |
| - Endpoints as described above | |
| 2. For POST and PUT requests, set the Content-Type header to `application/json` | |