Skip to content

Commit

Permalink
WIP
Browse files Browse the repository at this point in the history
  • Loading branch information
anthonyshew committed Jan 23, 2025
1 parent 14bb648 commit 20210eb
Showing 1 changed file with 40 additions and 22 deletions.
62 changes: 40 additions & 22 deletions examples/non-monorepo/README.md
Original file line number Diff line number Diff line change
@@ -1,36 +1,54 @@
This is a [Next.js](https://nextjs.org) project bootstrapped with [`create-next-app`](https://nextjs.org/docs/app/api-reference/cli/create-next-app).
# Turborepo non-monorepo starter

## Getting Started
This Turborepo starter is maintained by the Turborepo core team.

First, run the development server:
## Using this example

```bash
npm run dev
# or
yarn dev
# or
pnpm dev
# or
bun dev
Run the following command:

```sh
npx create-turbo@latest -e non-monorepo
```

Open [http://localhost:3000](http://localhost:3000) with your browser to see the result.
## What's inside?

This Turborepo uses a single, non-monorepo project (in this case, a single Next.js application).

### Tasks

There are several Turborepo tasks already set up for you to use.

#### Build the application

```
pnpm turbo build
```

You can start editing the page by modifying `app/page.tsx`. The page auto-updates as you edit the file.
#### Lint source code

This project uses [`next/font`](https://nextjs.org/docs/app/building-your-application/optimizing/fonts) to automatically optimize and load [Geist](https://vercel.com/font), a new font family for Vercel.
```
pnpm turbo lint
```

## Learn More
#### Type check source code

To learn more about Next.js, take a look at the following resources:
```
pnpm turbo check-types
```

- [Next.js Documentation](https://nextjs.org/docs) - learn about Next.js features and API.
- [Learn Next.js](https://nextjs.org/learn) - an interactive Next.js tutorial.
#### Run the application's development server

You can check out [the Next.js GitHub repository](https://github.com/vercel/next.js) - your feedback and contributions are welcome!
```
pnpm turbo dev
```

## Deploy on Vercel
## Useful Links

The easiest way to deploy your Next.js app is to use the [Vercel Platform](https://vercel.com/new?utm_medium=default-template&filter=next.js&utm_source=create-next-app&utm_campaign=create-next-app-readme) from the creators of Next.js.
Learn more about the power of Turborepo:

Check out our [Next.js deployment documentation](https://nextjs.org/docs/app/building-your-application/deploying) for more details.
- [Tasks](https://turbo.build/repo/docs/core-concepts/monorepos/running-tasks)
- [Caching](https://turbo.build/repo/docs/core-concepts/caching)
- [Remote Caching](https://turbo.build/repo/docs/core-concepts/remote-caching)
- [Filtering](https://turbo.build/repo/docs/core-concepts/monorepos/filtering)
- [Configuration Options](https://turbo.build/repo/docs/reference/configuration)
- [CLI Usage](https://turbo.build/repo/docs/reference/command-line-reference)

0 comments on commit 20210eb

Please # to comment.