studio/cunningham
2
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

📝(global) add README.md

Browse Source 
Create a first version of README.md
This commit is contained in:
Nathan Vasse
2022-12-01 14:50:15 +01:00
committed by NathanVss
parent 7ad502c2c7
commit d1a4e7611c
2 changed files with 30 additions and 55 deletions
Download Patch File Download Diff File Expand all files Collapse all files

73
README.md
View File

@@ -1,73 +1,48 @@
# Turborepo starter
`# Cunningham, the best OpenSource Design System`
This is an official Yarn v1 starter turborepo.
[![CircleCI](https://circleci.com/gh/openfun/cunningham/tree/master.svg?style=svg)](https://circleci.com/gh/openfun/richie/tree/master)
## What's inside?
## Getting started
This turborepo uses [Yarn](https://classic.yarnpkg.com/) as a package manager. It includes the following packages/apps:
Packages are not published yet, but once it is done we will show people how to install packages.
### Apps and Packages
## Development
- `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
### First start
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:
Install and build packages
```
cd my-turborepo
yarn run build
make bootstrap
```
### Develop
To develop all apps and packages, run the following command:
And then run dev servers
```
cd my-turborepo
yarn run dev
make dev
```
### Remote Caching
Then, you will be able to access the demo app on `http://localhost:3200` and the React components package's Storybook on
`http://localhost:6006`
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.
### Building
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:
In order to build all packages of this repo you just need to type the following command at the root of the monorepo.
```
cd my-turborepo
npx turbo login
make build
```
This will authenticate the Turborepo CLI with your [Vercel account](https://vercel.com/docs/concepts/personal-accounts/overview).
## Contributing
Next, you can link your Turborepo to your Remote Cache by running the following command from the root of your turborepo:
This project is intended to be community-driven, so please, do not hesitate to
get in touch if you have any question related to our implementation or design
decisions.
```
npx turbo link
```
We try to raise our code quality standards and expect contributors to follow
the recommandations from our
[handbook](https://openfun.gitbooks.io/handbook/content).
## Useful Links
## License
Learn more about the power of Turborepo:
- [Pipelines](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)
This work is released under the MIT License (see [LICENSE](./LICENSE)).