Skip to content

Commit

Permalink
Update README.md (#179)
Browse files Browse the repository at this point in the history
  • Loading branch information
Brokyeom authored Oct 20, 2024
1 parent 782a3cc commit 819eeaa
Showing 1 changed file with 17 additions and 81 deletions.
98 changes: 17 additions & 81 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,81 +1,17 @@
# Turborepo starter

This is an official starter Turborepo.

## Using this example

Run the following command:

```sh
npx create-turbo@latest
```

## What's inside?

This Turborepo includes the following packages/apps:

### Apps and Packages

- `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

Each package/app is 100% [TypeScript](https://www.typescriptlang.org/).

### Utilities

This Turborepo has some additional tools already setup for you:

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

### 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)
<div align='center'>
<image src='https://github.com/user-attachments/assets/ab037184-42c3-4fa7-ad04-8fa45a5ac4d4' alt='mds thumbnail' width=300 align='center' />
</div>


# mds
**The Design System for SOPT makers**

- Links
- [Github](https://github.com/sopt-makers/makers-design-system)
- [npm](https://www.npmjs.com/search?q=%40sopt-makers)
- [Storybook](https://main--6571c88390d085ed7efcce84.chromatic.com/?path=/docs/configure-your-project--docs)
- Packages
- [colors](https://www.npmjs.com/package/@sopt-makers/colors)
- [icon](https://www.npmjs.com/package/@sopt-makers/icons)
- [fonts](https://www.npmjs.com/package/@sopt-makers/fonts)
- [ui](https://www.npmjs.com/package/@sopt-makers/ui)

0 comments on commit 819eeaa

Please sign in to comment.