Skip to content

Commit

Permalink
📝 Update README.md files
Browse files Browse the repository at this point in the history
  • Loading branch information
GusFurtado committed Mar 15, 2022
1 parent bbab43d commit 0fb6eb9
Show file tree
Hide file tree
Showing 3 changed files with 65 additions and 8 deletions.
20 changes: 12 additions & 8 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,27 +1,31 @@
# Dash Charlotte

A package of themes, tools and components that I use on my Plotly-Dash web applications.
A package of themes, tools and components that I use on my Plotly-Dash web dashboards.

This is still a super early work in progress and probably not very interesting, so don't waste your time here.

## Submodules

- **Components**
- [**Components**](https://github.com/GusFurtado/dash-charlotte/tree/main/dash_charlotte/components)

Some Dash components for fast dashboard building.
A set of standard Dash components for a fast and modular dashboard building.

- **Themes**
- [**Themes**](https://github.com/GusFurtado/dash-charlotte/tree/main/dash_charlotte/themes)

Colors, fonts, icon packages and CSS stuff.
Tools for easy and consistent styling. Colors, fonts, icon packages and CSS stuff.

- **Layouts**
- [**Layouts**](https://github.com/GusFurtado/dash-charlotte/tree/main/dash_charlotte/layouts)

Some pre-built page layouts.

## Instatlation

By `pip` in a near future.
- `pip install dash-charlotte`

## License

- [MIT]([LICENSE])
- [**MIT**]([LICENSE])

## Getting Started

Check the [example app](https://github.com/GusFurtado/dash-charlotte/blob/main/example_app.py).
8 changes: 8 additions & 0 deletions dash_charlotte/components/README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,8 @@
# Dash Charlotte Components

A set of standard Dash components for a fast and modular dashboard building.

- [**Box**](https://github.com/GusFurtado/dash-charlotte/blob/main/dash_charlotte/components/box.py)
- [**Dashboard**](https://github.com/GusFurtado/dash-charlotte/blob/main/dash_charlotte/components/dashboard.py)
- [**Drawer**](https://github.com/GusFurtado/dash-charlotte/blob/main/dash_charlotte/components/drawer.py)
- [**Navbar**](https://github.com/GusFurtado/dash-charlotte/blob/main/dash_charlotte/components/navbar.py)
45 changes: 45 additions & 0 deletions dash_charlotte/themes/README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,45 @@
# Dash Charlotte Themes

Tools for easy and consistent styling.

Add them in Dash's `external_stylesheet` argument:

```python
from dash import Dash
import dash_labs as dl
import dash_bootstrap_components as dbc

from dash_charlotte import themes

app = Dash(
name = __name__,
title = 'Dash Charlotte',
plugins = [dl.plugins.pages],
external_stylesheets = [
dbc.themes.BOOTSTRAP,
themes.BOOTSTRAP,
themes.BOXICONS,
themes.FONTAWESOME,
themes.CHARLOTTE_LIGHT
]
)
```

---

- Colors
- [**Bootstrap**](https://github.com/GusFurtado/dash-charlotte/blob/main/dash_charlotte/themes/bootstrap.py)
- [**Charlotte Dark**](https://github.com/GusFurtado/dash-charlotte/blob/main/dash_charlotte/themes/charlotte_dark.py)
- [**Charlotte Light**](https://github.com/GusFurtado/dash-charlotte/blob/main/dash_charlotte/themes/charlotte_light.py)
- [**Colorblind**](https://github.com/GusFurtado/dash-charlotte/blob/main/dash_charlotte/themes/colorblind.py)
- [**Dracula**](https://github.com/GusFurtado/dash-charlotte/blob/main/dash_charlotte/themes/dracula.py)
- [**Fonts**](https://github.com/GusFurtado/dash-charlotte/blob/main/dash_charlotte/themes/fonts.py)
- Fire Code
- Montserrat
- Nunito
- Poppins
- Roboto
- [**Icons**](https://github.com/GusFurtado/dash-charlotte/blob/main/dash_charlotte/themes/icons.py)
- Bootstrap Icons
- Boxicons
- FontAwesome

0 comments on commit 0fb6eb9

Please sign in to comment.