Skip to content

feat: change app folder to frontend #2

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

Merged
drewlyton merged 1 commit into from
Jan 13, 2025
Merged

feat: change app folder to frontend #2

Show file tree
Hide file tree
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
10 changes: 5 additions & 5 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@ A minimal scaffolding template for creating your own [Sanity](https://www.sanity
## Folder Structure

```plaintext
├── app/ # Your frontend application
├── frontend/ # Your frontend application
├── studio/ # Sanity Studio
└── package.json # Root workspace configuration
```
Expand All @@ -25,14 +25,14 @@ npm install
```

### Add a Frontend Framework
Install your preferred frontend framework. The command below installs a new Next.js project in the `app` directory.
Install your preferred frontend framework. The command below installs a new Next.js project in the `frontend` directory.

```bash
npx create-next-app@latest app
npx create-next-app@latest frontend
```

### Customize Frontend Package
The app package is already defined as a workspace in the root `package.json`, but you may need to customize as needed.
The frontend package is already defined as a workspace in the root `package.json`, but you may need to customize as needed.

### Configure Environment Variables
Create an `.env.example` file in your frontend directory with the following variables:
Expand Down Expand Up @@ -76,7 +76,7 @@ You have the freedom to deploy your app to your hosting provider of choice. With

1. Create a GitHub repository from this project. Learn more.
2. Create a new Vercel project and connect it to your Github repository.
3. Set the Root Directory to your `app` directory.
3. Set the Root Directory to your `frontend` directory.
4. Configure your Environment Variables.

### Validate Template
Expand Down
Empty file added frontend/.gitkeep
View file
Open in desktop
Empty file.
4 changes: 2 additions & 2 deletions package.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2,13 +2,13 @@
"name": "my-sanity-template",
"scripts": {
"dev": "npm-run-all --parallel dev:*",
"dev:app": "cd studio && npm run dev",
"dev:frontend": "cd frontend && npm run dev",
"dev:studio": "cd studio && npm run dev",
"deploy:studio": "cd studio && sanity deploy",
"validate": "sanity-template-validate"
},
"workspaces": [
"app",
"frontend",
"studio"
],
"devDependencies": {
Expand Down
Loading