Skip to content

Commit 011edce

Browse files
#2325 add Readme for components project and cleanup Main readme (#2326)
1 parent 585b4aa commit 011edce

5 files changed

Lines changed: 127 additions & 4 deletions

File tree

README.md

Lines changed: 19 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -25,17 +25,17 @@
2525
</p>
2626

2727
![Demo Gif](./docs/resources/demo.gif)
28-
---
28+
2929
## Table of contents
3030

31-
- [](#)
32-
- [Table of contents](#table-of-contents)
3331
- [Introduction](#introduction)
32+
- [Connect with us](#connect-with-us)
3433
- [Features](#features)
3534
- [Supported Databases](#supported-databases)
3635
- [Getting Started](#getting-started)
3736
- [Prerequisites](#prerequisites)
3837
- [Installation](#installation)
38+
- [Component Library](#component-library)
3939
- [Documentation](#documentation)
4040
- [Contributing](#contributing)
4141
- [License](#license)
@@ -45,6 +45,18 @@ FluentCMS is a modern Content Management System (CMS) built on the powerful ASP.
4545

4646
FluentCMS is an open-source project, and we welcome contributions from the community. If you're interested in helping us improve FluentCMS, please read our [CONTRIBUTING.md](./CONTRIBUTING.md) guide.
4747

48+
## Connect with us
49+
50+
<a href="https://discord.gg/WyqYuC6YbY">
51+
<img width="48" height="48" src="/docs/resources/discord.svg" alt="discord">
52+
</a>
53+
<a href="https://reddit.com/r/FluentCMS">
54+
<img width="48" height="48" src="/docs/resources/reddit.svg" alt="reddit">
55+
</a>
56+
<a href="https://fluentcms.com">
57+
<img width="48" height="48" src="/docs/resources/website.svg" alt="website">
58+
</a>
59+
4860
## Features
4961

5062
- **Blazing Fast**: Built on top of Blazor components for client-side operations.
@@ -123,6 +135,10 @@ FluentCMS is an open-source project, and we welcome contributions from the commu
123135

124136
5. Visit `http://localhost:5000` in your browser.
125137

138+
## Component Library
139+
140+
This project includes a custom, independent Blazor-based component library styled with flowbite's Design System. You can learn more in [Component Library's README file](/src/Frontend/FluentCMS.Web.UI.Components/).
141+
126142
## Documentation
127143

128144
For more information on how to use FluentCMS, please refer to our [documentation](./docs/README.md). We are actively working on expanding our documentation to provide more detailed information.

docs/resources/discord.svg

Lines changed: 1 addition & 0 deletions
Loading

docs/resources/reddit.svg

Lines changed: 1 addition & 0 deletions
Loading

docs/resources/website.svg

Lines changed: 15 additions & 0 deletions
Loading
Lines changed: 91 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1 +1,91 @@
1-
# FluentCMS Web UI Components
1+
# FluentCMS Component Library
2+
3+
A custom Blazor-based component library designed with Flowbite styles, providing a rich set of reusable and modular UI components. These components are built based on our needs in FluentCMS.
4+
5+
## Components
6+
The library includes the following components:
7+
8+
### General Components
9+
- [x] Accordion
10+
- [x] Alert
11+
- [x] Avatar
12+
- [x] Badge
13+
- [x] Breadcrumb
14+
- [x] Button
15+
- [x] Card
16+
- [x] CloseButton
17+
- [x] Confirm
18+
- [x] DataTable
19+
- [x] Divider
20+
- [x] Dropdown
21+
- [x] Grid & GridItem
22+
- [x] Icon
23+
- [x] Indicator
24+
- [x] InlineEditor
25+
- [x] Modal
26+
- [x] Pagination
27+
- [x] Spacer
28+
- [x] Spinner
29+
- [x] Stack
30+
- [x] Stepper
31+
- [x] Tabs
32+
- [x] Toast
33+
- [x] Tooltip
34+
- [x] Typography
35+
36+
### Form Components
37+
- [x] Autocomplete
38+
- [x] Checkbox
39+
- [x] CheckboxGroup
40+
- [x] DateInput
41+
- [x] FileUpload
42+
- [x] Input
43+
- [x] MarkdownEditor
44+
- [x] NumberInput
45+
- [x] TreeSelector
46+
- [x] RichTextEditor
47+
- [x] RadioGroup
48+
- [x] Select
49+
- [x] Switch
50+
- [x] Textarea
51+
- [x] Label
52+
- [x] FormField
53+
54+
## Getting Started
55+
56+
### Installation
57+
58+
1. Install nuget package:
59+
60+
```bash
61+
dotnet package add FluentCMS.Web.UI.Components
62+
```
63+
64+
2. Register UI Components service in `Program.cs` file:
65+
66+
```cs
67+
builder.Services.AddUIComponents();
68+
```
69+
70+
3. Add link to Styles in head section of the `App.razor` file:
71+
72+
```razor
73+
<link rel="stylesheet" href="/_content/FluentCMS.Web.UI.Components/css/flowbite.min.css">
74+
```
75+
4. Use components in your project:
76+
```razor
77+
<Button Type="ButtonType.Submit" Color="Color.Primary">Submit</Button>
78+
<Button @onclick="() => Console.WriteLine("Cancelled")">Cancel</Button>
79+
```
80+
81+
5. Run the application:
82+
83+
```bash
84+
dotnet run
85+
```
86+
87+
## Contribution
88+
We welcome contributions! If you'd like to contribute, please open an issue or submit a pull request.
89+
90+
## License
91+
This project is open-source and available under the MIT License.

0 commit comments

Comments
 (0)