Skip to content

Commit

Permalink
docs: update docs
Browse files Browse the repository at this point in the history
  • Loading branch information
gabitoesmiapodo committed Jun 26, 2024
1 parent e5ed5cc commit 1e8bbc0
Showing 1 changed file with 23 additions and 11 deletions.
34 changes: 23 additions & 11 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -149,9 +149,13 @@ export default {
- Install [eslint-plugin-react](https://github.com/jsx-eslint/eslint-plugin-react) and add `plugin:react/recommended` & `plugin:react/jsx-runtime` to the `extends` list
</details>

# Styles
# UI Libraries / Styles

## Styled Components
## Browser Normalizing

We use [modern-normalize](https://github.com/sindresorhus/modern-normalize) to normalize the browsers' default styles.

## Styles

We use [Styled Components](https://styled-components.com/) a popular, powerful, and easy to use CSS-in-JS solution in dAppBoster to add styles to our components.

Expand All @@ -161,23 +165,31 @@ Additionally, several other Styled Components-related tools are provided to faci
- [stylelint-config-standard](https://github.com/stylelint/stylelint-config-standard), extends the standard Stylelint configuration.
- [postcss-styled-syntax](https://github.com/hudochenkov/postcss-styled-syntax), parses the components and extracts the CSS from them.

## Styles implementation

We use [modern-normalize](https://github.com/sindresorhus/modern-normalize) to normalize the browsers' default styles.
### Styles Implementation details

You can find all the general app's styles in the `src/styles` folder:
You can find the general app's styles in the `src/styles` folder:

- `base.tsx` global CSS vars, used everywhere in the app.
- `themes/light.tsx` light theme CSS vars.
- `themes/dark.tsx` dark theme CSS vars.
- `breakpoints.tsx` utility functions for responsive, mobile-first CSS.
- `globalStyles.tsx` global app's CSS.

## Themes

dAppBooster supports themes with the help of https://github.com/pacocoursey/next-themes
dAppBooster supports themes with the help of [Next Themes](https://github.com/pacocoursey/next-themes)

### Themes implementation

We provide these two themes for your convenience. Generally speaking, you can use these when you can't or don't want to modify a component's source file to add styles.

- `themes/light.tsx` light theme CSS vars.
- `themes/dark.tsx` dark theme CSS vars.

You can also add CSS theme vars and more in each component's implementation following our examples and Next Themes' documentation.

## Toasts

We use [React Hot Toast](https://github.com/timolins/react-hot-toast)

# Control Version System
# Control Version

As a best practice, we follow and enforce the usage of [conventional commits](https://www.conventionalcommits.org/en/v1.0.0/#summary) for commit messages' and pull requests' titles.

Expand Down

0 comments on commit 1e8bbc0

Please sign in to comment.