Skip to content

docs: Add CORS configuration section to README #81

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
edisonlv wants to merge 1 commit into
base: main
Choose a base branch
from
Open

docs: Add CORS configuration section to README #81

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
17 changes: 17 additions & 0 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -41,6 +41,23 @@ uvicorn app.main:app --reload
| DELETE | `/profile/{username}` | Delete a profile |
| GET | `/search?q=term` | Search profiles |

## CORS Configuration

The application includes CORS middleware that allows requests from all origins.
This is configured in `app/main.py`:

```python
app.add_middleware(
CORSMiddleware,
allow_origins=["*"],
allow_methods=["*"],
allow_headers=["*"],
)
```

> **Note:** The current configuration allows all origins (`*`), which is suitable for development.
> For production deployments, restrict `allow_origins` to your specific frontend domain(s).

## Running Tests

```bash
Expand Down