Skip to content

Commit 6deb4de

Browse files
sonofmagicsonofmagic
authored
Initial commit
0 parents  commit 6deb4de

File tree

12 files changed

+253
-0
lines changed

12 files changed

+253
-0
lines changed

‎.editorconfig

Lines changed: 12 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,12 @@
1+
# EditorConfig is awesome: https://EditorConfig.org
2+
3+
# top-most EditorConfig file
4+
root = true
5+
6+
[*]
7+
indent_style = space
8+
indent_size = 2
9+
end_of_line = lf
10+
charset = utf-8
11+
trim_trailing_whitespace = false
12+
insert_final_newline = false

‎.eslintrc.js

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,4 @@
1+
module.exports = {
2+
root: true,
3+
extends: []
4+
}

‎.gitignore

Lines changed: 33 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,33 @@
1+
# See https://help.github.com/articles/ignoring-files/ for more about ignoring files.
2+
3+
# dependencies
4+
node_modules
5+
.pnp
6+
.pnp.js
7+
8+
# testing
9+
coverage
10+
11+
# next.js
12+
.next/
13+
out/
14+
build
15+
16+
# misc
17+
.DS_Store
18+
*.pem
19+
20+
# debug
21+
npm-debug.log*
22+
yarn-debug.log*
23+
yarn-error.log*
24+
.pnpm-debug.log*
25+
26+
# local env files
27+
.env.local
28+
.env.development.local
29+
.env.test.local
30+
.env.production.local
31+
32+
# turbo
33+
.turbo

‎.npmrc

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1 @@
1+
registry=http://registry.npmmirror.com/

‎.prettierrc

Lines changed: 9 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,9 @@
1+
{
2+
"tabWidth": 2,
3+
"useTabs": false,
4+
"semi": false,
5+
"singleQuote": true,
6+
"endOfLine": "lf",
7+
"trailingComma": "none",
8+
"printWidth": 180
9+
}

‎README.md

Lines changed: 73 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,73 @@
1+
# pnpm-turbo-monorepo-template
2+
3+
This is a empty pnpm starter turborepo for me.
4+
5+
## What's inside?
6+
7+
This turborepo uses [pnpm](https://pnpm.io) as a package manager. It includes the following packages/apps:
8+
9+
### Apps and Packages
10+
11+
- `docs`: a [Next.js](https://nextjs.org/) app
12+
- `web`: another [Next.js](https://nextjs.org/) app
13+
- `ui`: a stub React component library shared by both `web` and `docs` applications
14+
- `eslint-config-custom`: `eslint` configurations (includes `eslint-config-next` and `eslint-config-prettier`)
15+
- `tsconfig`: `tsconfig.json`s used throughout the monorepo
16+
17+
Each package/app is 100% [TypeScript](https://www.typescriptlang.org/).
18+
19+
### Utilities
20+
21+
This turborepo has some additional tools already setup for you:
22+
23+
- [TypeScript](https://www.typescriptlang.org/) for static type checking
24+
- [ESLint](https://eslint.org/) for code linting
25+
- [Prettier](https://prettier.io) for code formatting
26+
27+
### Build
28+
29+
To build all apps and packages, run the following command:
30+
31+
```
32+
cd my-turborepo
33+
pnpm run build
34+
```
35+
36+
### Develop
37+
38+
To develop all apps and packages, run the following command:
39+
40+
```
41+
cd my-turborepo
42+
pnpm run dev
43+
```
44+
45+
### Remote Caching
46+
47+
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.
48+
49+
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:
50+
51+
```
52+
cd my-turborepo
53+
pnpm dlx turbo login
54+
```
55+
56+
This will authenticate the Turborepo CLI with your [Vercel account](https://vercel.com/docs/concepts/personal-accounts/overview).
57+
58+
Next, you can link your Turborepo to your Remote Cache by running the following command from the root of your turborepo:
59+
60+
```
61+
pnpm dlx turbo link
62+
```
63+
64+
## Useful Links
65+
66+
Learn more about the power of Turborepo:
67+
68+
- [Pipelines](https://turbo.build/repo/docs/core-concepts/monorepos/running-tasks)
69+
- [Caching](https://turbo.build/repo/docs/core-concepts/caching)
70+
- [Remote Caching](https://turbo.build/repo/docs/core-concepts/remote-caching)
71+
- [Filtering](https://turbo.build/repo/docs/core-concepts/monorepos/filtering)
72+
- [Configuration Options](https://turbo.build/repo/docs/reference/configuration)
73+
- [CLI Usage](https://turbo.build/repo/docs/reference/command-line-reference)

‎apps/.gitkeep

Whitespace-only changes.

‎package.json

Lines changed: 23 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,23 @@
1+
{
2+
"name": "pnpm-turbo-monorepo-template",
3+
"version": "0.0.0",
4+
"private": true,
5+
"workspaces": [
6+
"apps/*",
7+
"packages/*"
8+
],
9+
"scripts": {
10+
"build": "turbo run build",
11+
"dev": "turbo run dev --parallel",
12+
"lint": "turbo run lint",
13+
"format": "prettier --write \"**/*.{ts,tsx,md}\""
14+
},
15+
"devDependencies": {
16+
"prettier": "^2.8.7",
17+
"turbo": "^1.8.8"
18+
},
19+
"engines": {
20+
"node": ">=14.0.0"
21+
},
22+
"packageManager": "[email protected]"
23+
}

‎packages/.gitkeep

Whitespace-only changes.

‎pnpm-lock.yaml

Lines changed: 80 additions & 0 deletions
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

0 commit comments

Comments
 (0)