Skip to content

Commit

Permalink
Updated README.md
Browse files Browse the repository at this point in the history
  • Loading branch information
rcrdk committed Mar 13, 2024
1 parent 75e0e88 commit f13e09b
Show file tree
Hide file tree
Showing 3 changed files with 46 additions and 7 deletions.
18 changes: 11 additions & 7 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,23 +1,27 @@
# 📗 Ignite Call Design System
I developed this project during classes and as a challenge of my latest studies on React lessons at [Rocketseat](https://www.rocketseat.com.br). The documentation is available [here](https://rcrdk.github.io/design-system-ignite/).

## 🎮 Usage
```shell
npm i @rcrdk-ignite-ui/tokens
npm i @rcrdk-ignite-ui/react
```

## 🚀 Techs and Tools

- [React](https://reactjs.org) + [TypeScript](https://www.typescriptlang.org/)
- [Stitches](https://stitches.dev)
- [Storybook](https://storybook.js.org/)
- [TSUP](https://github.com/egoist/tsup)
- [Turborepo](https://turbo.build/)
- [Github Actions](https://github.com/features/actions) + [GitHub Pages](https://pages.github.com/)
- [Changeset](https://github.com/changesets/changesets) + [NPM Package Publication](https://www.npmjs.com/)
- [Changesets](https://github.com/changesets/changesets) + [NPM Package Publication](https://www.npmjs.com/)

## 🎨 About

> Soon...
<!-- This project was developed based on a Figma design provied by the school. The main practice was the integration between this Next.js application and the Stripe API.
The products was added on Stripe platform and it's API was used to retrieve product and manage order checkout. It was used Use Shopping Cart, specific for Stripe data,
for managing states and logic of cart. The project was developed under Next.js framework where were applied static site generation (SSG). serve-side rendering (SSR)
and API Routes for better caching and performance, more readability for SEO and for safety reasons such as procteting secret variables. -->
This project was developed based on a Figma design provied by the school. The main practice was the creation of a Design System into a monorepo, a workspace with more than one project inside. It was used TSUP to bundle React and Tokens projects; And Stitches for styling components. All documentation was written using Storybook bases. It was used TurboRepo for running scripts on all packages in parallel and for caching dependencies.

It was used GitHub Actions to publish the [documentation](https://rcrdk.github.io/design-system-ignite/) at GitHub Pages and publish the Tokens and React packages at [NPM](https://www.npmjs.com/search?q=%40rcrdk-ignite-ui). Versioning control was made with Changesets.

## 🧩 Components
See the [full documentation](https://rcrdk.github.io/design-system-ignite/).
Expand All @@ -36,4 +40,4 @@ See the [full documentation](https://rcrdk.github.io/design-system-ignite/).

## 💻 Projects

> In development...
- Ignite Call *(Soon)*
24 changes: 24 additions & 0 deletions packages/react/README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,24 @@
# Ignite Call Design System
I developed this project during classes and as a challenge of my latest studies on React lessons at [Rocketseat](https://www.rocketseat.com.br). The documentation is available [here](https://rcrdk.github.io/design-system-ignite/).

## Usage
```shell
npm i @rcrdk-ignite-ui/react
```

## Components
- Text
- Heading
- Button
- Box
- Text Input
- Text Area
- Checkbox
- Multi Step
- Avatar
- Toast
- Tooltip

## Links
- [Docs](https://rcrdk.github.io/design-system-ignite/)
- [GitHub Repo]()
11 changes: 11 additions & 0 deletions packages/tokens/README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,11 @@
# Ignite Call Design System
I developed this project during classes and as a challenge of my latest studies on React lessons at [Rocketseat](https://www.rocketseat.com.br). The documentation is available [here](https://rcrdk.github.io/design-system-ignite/).

## Usage
```shell
npm i @rcrdk-ignite-ui/tokens
```

## Links
- [Docs](https://rcrdk.github.io/design-system-ignite/)
- [GitHub Repo](https://github.com/rcrdk/design-system-ignite/tree/%40rcrdk-ignite-ui/tokens%403.0.0)

0 comments on commit f13e09b

Please sign in to comment.