Skip to content

docs: fix DEPLOYMENT_VERCEL.md vercel.json examples #190

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
andrerfneves wants to merge 1 commit into
base: main
Choose a base branch
from
+10 −6
Open

docs: fix DEPLOYMENT_VERCEL.md vercel.json examples #190

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
16 changes: 10 additions & 6 deletions DEPLOYMENT_VERCEL.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -42,19 +42,20 @@ This runs `npm run build && vercel --prod`.

## Configuration

### vercel.json (Optional)
### vercel.json

Create a `vercel.json` file in your project root for custom configuration:
The project includes a `vercel.json` with the following configuration:

```json
{
"framework": "vite",
"buildCommand": "npm run build",
"outputDirectory": "build",
"devCommand": "npm run dev",
"installCommand": "npm install"
"outputDirectory": "build"
}
```

The `framework` field tells Vercel to use Vite-optimized settings. The `buildCommand` and `outputDirectory` fields ensure Vercel uses the correct build output path. If you need to add custom configuration (e.g., rewrites), merge them into the existing file rather than replacing it.

### Environment Variables

No environment variables are required for the base application.
Expand Down Expand Up @@ -91,10 +92,13 @@ Check the build logs in your Vercel dashboard. Common issues:

### 404 errors on page refresh

This is a common issue with single-page applications. Create a `vercel.json`:
This is a common issue with single-page applications. Add the following rewrites to the project's existing `vercel.json`:

```json
{
"framework": "vite",
"buildCommand": "npm run build",
"outputDirectory": "build",
"rewrites": [
{ "source": "/(.*)", "destination": "/index.html" }
]
Expand Down
Loading