Skip to content

Commit e51f01b

Browse files
turbobot-tempsamuelhulla
authored andcommitted
feat(create-turbo): apply official-starter transform
1 parent 850135a commit e51f01b

30 files changed

+102
-25240
lines changed

.babelrc

Lines changed: 0 additions & 16 deletions
This file was deleted.

.editorconfig

Lines changed: 0 additions & 9 deletions
This file was deleted.

.eslintignore

Lines changed: 0 additions & 11 deletions
This file was deleted.

.eslintrc

Lines changed: 0 additions & 29 deletions
This file was deleted.

.gitignore

Lines changed: 22 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -1,24 +1,36 @@
1-
2-
# See https://help.github.com/ignore-files/ for more about ignoring files.
1+
# See https://help.github.com/articles/ignoring-files/ for more about ignoring files.
32

43
# dependencies
54
node_modules
5+
.pnp
6+
.pnp.js
67

7-
# builds
8-
build
9-
dist
8+
# testing
9+
coverage
1010

11-
.rpt2_cache
11+
# next.js
12+
.next/
13+
out/
14+
build
1215

1316
# misc
1417
.DS_Store
18+
*.pem
19+
20+
# debug
21+
npm-debug.log*
22+
yarn-debug.log*
23+
yarn-error.log*
24+
25+
# local env files
1526
.env
1627
.env.local
1728
.env.development.local
1829
.env.test.local
1930
.env.production.local
20-
.idea
2131

22-
npm-debug.log*
23-
yarn-debug.log*
24-
yarn-error.log*
32+
# turbo
33+
.turbo
34+
35+
# vercel
36+
.vercel

.travis.yml

Lines changed: 0 additions & 4 deletions
This file was deleted.

README.md

Lines changed: 67 additions & 21 deletions
Original file line numberDiff line numberDiff line change
@@ -1,35 +1,81 @@
1-
# react-firebase-messenger
1+
# Turborepo starter
22

3-
> Messenger tool based on firebase realtime database
3+
This is an official starter Turborepo.
44

5-
[![NPM](https://img.shields.io/npm/v/react-firebase-messenger.svg)](https://www.npmjs.com/package/react-firebase-messenger) [![JavaScript Style Guide](https://img.shields.io/badge/code_style-standard-brightgreen.svg)](https://standardjs.com)
5+
## Using this example
66

7-
## Install
7+
Run the following command:
88

9-
```bash
10-
npm install --save react-firebase-messenger
9+
```sh
10+
npx create-turbo@latest
1111
```
1212

13-
## Usage
13+
## What's inside?
1414

15-
```jsx
16-
import React, { Component } from 'react'
15+
This Turborepo includes the following packages/apps:
1716

18-
import MyComponent from 'react-firebase-messenger'
17+
### Apps and Packages
1918

20-
class Example extends Component {
21-
render () {
22-
return (
23-
<MyComponent />
24-
)
25-
}
26-
}
19+
- `docs`: a [Next.js](https://nextjs.org/) app
20+
- `web`: another [Next.js](https://nextjs.org/) app
21+
- `ui`: a stub React component library shared by both `web` and `docs` applications
22+
- `eslint-config-custom`: `eslint` configurations (includes `eslint-config-next` and `eslint-config-prettier`)
23+
- `tsconfig`: `tsconfig.json`s used throughout the monorepo
24+
25+
Each package/app is 100% [TypeScript](https://www.typescriptlang.org/).
26+
27+
### Utilities
28+
29+
This Turborepo has some additional tools already setup for you:
30+
31+
- [TypeScript](https://www.typescriptlang.org/) for static type checking
32+
- [ESLint](https://eslint.org/) for code linting
33+
- [Prettier](https://prettier.io) for code formatting
34+
35+
### Build
36+
37+
To build all apps and packages, run the following command:
38+
39+
```
40+
cd my-turborepo
41+
pnpm build
2742
```
2843

29-
## Linking
30-
For debugging in linked packages use `wml` https://github.com/wix/wml and not npm link, you will save yourself a lot of issues
44+
### Develop
45+
46+
To develop all apps and packages, run the following command:
47+
48+
```
49+
cd my-turborepo
50+
pnpm dev
51+
```
52+
53+
### Remote Caching
54+
55+
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.
56+
57+
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:
58+
59+
```
60+
cd my-turborepo
61+
npx turbo login
62+
```
63+
64+
This will authenticate the Turborepo CLI with your [Vercel account](https://vercel.com/docs/concepts/personal-accounts/overview).
65+
66+
Next, you can link your Turborepo to your Remote Cache by running the following command from the root of your Turborepo:
67+
68+
```
69+
npx turbo link
70+
```
3171

72+
## Useful Links
3273

33-
## License
74+
Learn more about the power of Turborepo:
3475

35-
MIT © [Webscope.io](https://github.com/Webscope.io)
76+
- [Tasks](https://turbo.build/repo/docs/core-concepts/monorepos/running-tasks)
77+
- [Caching](https://turbo.build/repo/docs/core-concepts/caching)
78+
- [Remote Caching](https://turbo.build/repo/docs/core-concepts/remote-caching)
79+
- [Filtering](https://turbo.build/repo/docs/core-concepts/monorepos/filtering)
80+
- [Configuration Options](https://turbo.build/repo/docs/reference/configuration)
81+
- [CLI Usage](https://turbo.build/repo/docs/reference/command-line-reference)

0 commit comments

Comments
 (0)