Skip to content

Commit

Permalink
feat(react-email): Add react.email folder
Browse files Browse the repository at this point in the history
  • Loading branch information
zenorocha committed Nov 24, 2023
1 parent 7e6fe59 commit 6b02df4
Show file tree
Hide file tree
Showing 52 changed files with 8,529 additions and 1,429 deletions.
1 change: 1 addition & 0 deletions .gitignore
Original file line number Diff line number Diff line change
Expand Up @@ -22,6 +22,7 @@ coverage
.vercel

# Build Outputs
.react-email/
.next/
out/
build
Expand Down
88 changes: 20 additions & 68 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,81 +1,33 @@
# Turborepo starter
# React Email with Turborepo + npm

This is an official starter Turborepo.
This example shows how to use React Email with [Turborepo](https://turbo.build) + [npm](https://npmjs.com).

## Using this example
### Structure

Run the following command:
This monorepo includes the following apps:

```sh
npx create-turbo@latest
```
- `apps/next`: a [Next.js](https://nextjs.org) app
- `apps/react-email`: a [react.email](https://react.email) app

## What's inside?
## Instructions

This Turborepo includes the following packages/apps:
1. Install dependencies:

### Apps and Packages
```sh
npm install
```

- `docs`: a [Next.js](https://nextjs.org/) app
- `web`: another [Next.js](https://nextjs.org/) app
- `ui`: a stub React component library shared by both `web` and `docs` applications
- `eslint-config-custom`: `eslint` configurations (includes `eslint-config-next` and `eslint-config-prettier`)
- `tsconfig`: `tsconfig.json`s used throughout the monorepo
2. Run locally:

Each package/app is 100% [TypeScript](https://www.typescriptlang.org/).
```sh
npm run dev
```

### Utilities
4. Open URLs in the browser:

This Turborepo has some additional tools already setup for you:
* http://localhost:3000
* http://localhost:3001

- [TypeScript](https://www.typescriptlang.org/) for static type checking
- [ESLint](https://eslint.org/) for code linting
- [Prettier](https://prettier.io) for code formatting
## License

### Build

To build all apps and packages, run the following command:

```
cd my-turborepo
pnpm build
```

### Develop

To develop all apps and packages, run the following command:

```
cd my-turborepo
pnpm dev
```

### Remote Caching

Turborepo can use a technique known as [Remote Caching](https://turbo.build/repo/docs/core-concepts/remote-caching) to share cache artifacts across machines, enabling you to share build caches with your team and CI/CD pipelines.

By default, Turborepo will cache locally. To enable Remote Caching you will need an account with Vercel. If you don't have an account you can [create one](https://vercel.com/signup), then enter the following commands:

```
cd my-turborepo
npx turbo login
```

This will authenticate the Turborepo CLI with your [Vercel account](https://vercel.com/docs/concepts/personal-accounts/overview).

Next, you can link your Turborepo to your Remote Cache by running the following command from the root of your Turborepo:

```
npx turbo link
```

## Useful Links

Learn more about the power of Turborepo:

- [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)
MIT License
28 changes: 0 additions & 28 deletions apps/docs/README.md

This file was deleted.

Binary file removed apps/docs/app/favicon.ico
Binary file not shown.
50 changes: 0 additions & 50 deletions apps/docs/app/globals.css

This file was deleted.

22 changes: 0 additions & 22 deletions apps/docs/app/layout.tsx

This file was deleted.

Loading

0 comments on commit 6b02df4

Please sign in to comment.