Skip to content

Navigation Menu

Sign in
Appearance settings

Search code, repositories, users, issues, pull requests...

Provide feedback

We read every piece of feedback, and take your input very seriously.

Saved searches

Use saved searches to filter your results more quickly

Appearance settings

Commit 6f2303a

Browse filesBrowse files
committed
revert: add README file
1 parent 82f2905 commit 6f2303a
Copy full SHA for 6f2303a

File tree

Expand file treeCollapse file tree

1 file changed

+261
-0
lines changed
Filter options
Expand file treeCollapse file tree

1 file changed

+261
-0
lines changed

‎README.md

Copy file name to clipboard
+261Lines changed: 261 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,261 @@
1+
<p align="center">
2+
<a href="https://coreui.io/">
3+
<img
4+
src="https://coreui.io/images/brand/coreui-signet.svg"
5+
alt="CoreUI logo"
6+
width="200"
7+
/>
8+
</a>
9+
</p>
10+
11+
<h3 align="center">CoreUI for React.js</h3>
12+
13+
<p align="center">
14+
React.js Components Library built on top of Bootstrap 5 and TypeScript.
15+
<br>
16+
<a href="https://coreui.io/react/docs/getting-started/introduction"><strong>Explore CoreUI for React.js docs »</strong></a>
17+
<br>
18+
<br>
19+
<a href="https://github.com/coreui/coreui-react/issues/new?template=bug_report.md">Report bug</a>
20+
·
21+
<a href="https://github.com/coreui/coreui-react/issues/new?template=feature_request.md">Request feature</a>
22+
·
23+
<a href="https://coreui.io/blog/">Blog</a>
24+
</p>
25+
26+
27+
## Table of contents
28+
29+
- [Quick start](#quick-start)
30+
- [Components](#components)
31+
- [Status](#status)
32+
- [Bugs and feature requests](#bugs-and-feature-requests)
33+
- [Documentation](#documentation)
34+
- [Frameworks](#frameworks)
35+
- [Templates](#templates)
36+
- [Contributing](#contributing)
37+
- [Community](#community)
38+
- [Versioning](#versioning)
39+
- [Creators](#creators)
40+
- [Support CoreUI Development](#support-coreui-development)
41+
- [Copyright and license](#copyright-and-license)
42+
43+
## Quick start
44+
45+
### Instalation
46+
47+
Several quick start options are available:
48+
49+
- [Download the latest release](https://github.com/coreui/coreui-react/archive/v4.4.0.zip)
50+
- Clone the repo: `git clone https://github.com/coreui/coreui-react.git`
51+
- Install with [npm](https://www.npmjs.com/): `npm install @coreui/react`
52+
- Install with [yarn](https://yarnpkg.com/): `yarn add @coreui/react`
53+
54+
Read the [Getting started page](https://coreui.io/react/docs/getting-started/introduction/) for information on the framework contents, templates and examples, and more.
55+
56+
### Stylesheets
57+
58+
React components are styled using `@coreui/coreui` CSS library, but you can use them also with bootstrap CSS library. That is possible because `@coreui/coreui` library is compatible with bootstrap, it just extends its functionalities. The only exception are custom CoreUI components, which don't exist in the Bootstrap ecosystem.
59+
60+
#### CoreUI CSS files
61+
62+
##### Installation
63+
64+
```bash
65+
yarn add @coreui/coreui
66+
```
67+
68+
or
69+
70+
```bash
71+
npm install @coreui/coreui --save
72+
```
73+
74+
##### Basic usage
75+
76+
```js
77+
import '@coreui/coreui/dist/css/coreui.min.css'
78+
```
79+
80+
#### Bootstrap CSS files
81+
82+
##### Installation
83+
84+
```bash
85+
yarn add bootstrap
86+
```
87+
88+
or
89+
90+
```bash
91+
npm install bootstrap
92+
```
93+
94+
##### Basic usage
95+
96+
```js
97+
import "bootstrap/dist/css/bootstrap.min.css";
98+
```
99+
100+
## Components
101+
102+
- [React Accordion](https://coreui.io/react/docs/components/accordion/)
103+
- [React Alert](https://coreui.io/react/docs/components/alert/)
104+
- [React Avatar](https://coreui.io/react/docs/components/avatar/)
105+
- [React Badge](https://coreui.io/react/docs/components/badge/)
106+
- [React Breadcrumb](https://coreui.io/react/docs/components/breadcrumb/)
107+
- [React Button](https://coreui.io/react/docs/components/button/)
108+
- [React Button Group](https://coreui.io/react/docs/components/button-group/)
109+
- [React Callout](https://coreui.io/react/docs/components/callout/)
110+
- [React Card](https://coreui.io/react/docs/components/card/)
111+
- [React Carousel](https://coreui.io/react/docs/components/carousel/)
112+
- [React Checkbox](https://coreui.io/react/docs/forms/checkbox/)
113+
- [React Close Button](https://coreui.io/react/docs/components/close-button/)
114+
- [React Collapse](https://coreui.io/react/docs/components/collapse/)
115+
- [React Date Picker](https://coreui.io/react/docs/forms/date-picker/) **PRO**
116+
- [React Date Range Picker](https://coreui.io/react/docs/forms/date-range-picker/) **PRO**
117+
- [React Dropdown](https://coreui.io/react/docs/components/dropdown/)
118+
- [React Floating Labels](https://coreui.io/react/docs/forms/floating-labels/)
119+
- [React Footer](https://coreui.io/react/docs/components/footer/)
120+
- [React Header](https://coreui.io/react/docs/components/header/)
121+
- [React Image](https://coreui.io/react/docs/components/image/)
122+
- [React Input](https://coreui.io/react/docs/forms/input/)
123+
- [React Input Group](https://coreui.io/react/docs/forms/input-group/)
124+
- [React List Group](https://coreui.io/react/docs/components/list-group/)
125+
- [React Loading Button](https://coreui.io/react/docs/components/loading-button/) **PRO**
126+
- [React Modal](https://coreui.io/react/docs/components/modal/)
127+
- [React Multi Select](https://coreui.io/react/docs/forms/multi-select/) **PRO**
128+
- [React Navs & Tabs](https://coreui.io/react/docs/components/navs-tabs/)
129+
- [React Navbar](https://coreui.io/react/docs/components/navbar/)
130+
- [React Offcanvas](https://coreui.io/react/docs/components/offcanvas/)
131+
- [React Pagination](https://coreui.io/react/docs/components/pagination/)
132+
- [React Placeholder](https://coreui.io/react/docs/components/placeholder/)
133+
- [React Popover](https://coreui.io/react/docs/components/popover/)
134+
- [React Progress](https://coreui.io/react/docs/components/progress/)
135+
- [React Radio](https://coreui.io/react/docs/forms/radio/)
136+
- [React Range](https://coreui.io/react/docs/forms/range/)
137+
- [React Select](https://coreui.io/react/docs/forms/select/)
138+
- [React Sidebar](https://coreui.io/react/docs/components/sidebar/)
139+
- [React Smart Pagination](https://coreui.io/react/docs/components/smart-pagination/) **PRO**
140+
- [React Smart Table](https://coreui.io/react/docs/components/smart-table/) **PRO**
141+
- [React Spinner](https://coreui.io/react/docs/components/spinner/)
142+
- [React Switch](https://coreui.io/react/docs/forms/switch/)
143+
- [React Table](https://coreui.io/react/docs/components/table/)
144+
- [React Textarea](https://coreui.io/react/docs/forms/textarea/)
145+
- [React Time Picker](https://coreui.io/react/docs/forms/time-picker/) **PRO**
146+
- [React Toast](https://coreui.io/react/docs/components/toast/)
147+
- [React Tooltip](https://coreui.io/react/docs/components/tooltip/)
148+
149+
## Status
150+
151+
[![npm version](https://img.shields.io/npm/v/@coreui/react)](https://www.npmjs.com/package/@coreui/react)
152+
153+
## Bugs and feature requests
154+
155+
Have a bug or a feature request? Please first read the [issue guidelines](https://github.com/coreui/coreui-react/blob/v4/.github/CONTRIBUTING.md#using-the-issue-tracker) and search for existing and closed issues. If your problem or idea is not addressed yet, [please open a new issue](https://github.com/coreui/coreui-react/issues/new).
156+
157+
## Documentation
158+
159+
The documentation for the CoreUI & CoreUI PRO is hosted at our website [CoreUI for React](https://coreui.io/react/docs/getting-started/introduction)
160+
161+
### Running documentation locally
162+
163+
1. Run `yarn install` or `npm install` to install the Node.js dependencies.
164+
2. Run `yarn bootstrap` or `npm run bootstrap` to link local packages together and install remaining package dependencies.
165+
3. From the root directory, run `yarn docs:dev` or `npm run docs:dev` (or a specific npm script) to rebuild distributed CSS and JavaScript files, as well as our docs assets.
166+
4. Open `http://localhost:8000/` in your browser, and voilà.
167+
168+
## Frameworks
169+
170+
CoreUI supports most popular frameworks.
171+
172+
- [CoreUI for Angular](https://github.com/coreui/coreui-angular)
173+
- [CoreUI for Bootstrap (Vanilla JS)](https://github.com/coreui/coreui)
174+
- [CoreUI for React](https://github.com/coreui/coreui-react)
175+
- [CoreUI for Vue](https://github.com/coreui/coreui-vue)
176+
177+
## Templates
178+
179+
Fully featured, out-of-the-box, templates for your application based on CoreUI.
180+
181+
- [Angular Admin Template](https://coreui.io/angular)
182+
- [Bootstrap Admin Template](https://coreui.io/)
183+
- [React Admin Template](https://coreui.io/react)
184+
- [Vue Admin Template](https://coreui.io/vue)
185+
186+
## Contributing
187+
188+
Please read through our [contributing guidelines](https://github.com/coreui/coreui-react/blob/v4/.github/CONTRIBUTING.md). Included are directions for opening issues, coding standards, and notes on development.
189+
190+
Editor preferences are available in the [editor config](https://github.com/coreui/coreui-react/blob/v4/.editorconfig) for easy use in common text editors. Read more and download plugins at <https://editorconfig.org/>.
191+
192+
## Community
193+
194+
Stay up to date on the development of CoreUI and reach out to the community with these helpful resources.
195+
196+
- Read and subscribe to [The Official CoreUI Blog](https://coreui.io/blog/).
197+
198+
You can also follow [@core_ui on Twitter](https://twitter.com/core_ui).
199+
200+
## Versioning
201+
202+
For transparency into our release cycle and in striving to maintain backward compatibility, CoreUI is maintained under [the Semantic Versioning guidelines](http://semver.org/).
203+
204+
See [the Releases section of our project](https://github.com/coreui/coreui-react/releases) for changelogs for each release version.
205+
206+
## Creators
207+
208+
**Łukasz Holeczek**
209+
210+
- <https://twitter.com/lukaszholeczek>
211+
- <https://github.com/mrholek>
212+
213+
**Andrzej Kopański**
214+
215+
- <https://github.com/xidedix>
216+
217+
**The CoreUI Team**
218+
219+
- <https://github.com/orgs/coreui/people>
220+
221+
## Support CoreUI Development
222+
223+
CoreUI is an MIT-licensed open source project and is completely free to use. However, the amount of effort needed to maintain and develop new features for the project is not sustainable without proper financial backing. You can support development by buying the [CoreUI PRO](https://coreui.io/pricing/) or by becoming a sponsor via [Open Collective](https://opencollective.com/coreui/).
224+
225+
<!--- StartOpenCollectiveBackers -->
226+
227+
### Platinum Sponsors
228+
229+
Support this project by [becoming a Platinum Sponsor](https://opencollective.com/coreui/contribute/platinum-sponsor-40959/). A large company logo will be added here with a link to your website.
230+
231+
<a href="https://opencollective.com/coreui/contribute/platinum-sponsor-40959/checkout"><img src="https://opencollective.com/coreui/tiers/platinum-sponsor/0/avatar.svg?avatarHeight=100"></a>
232+
233+
### Gold Sponsors
234+
235+
Support this project by [becoming a Gold Sponsor](https://opencollective.com/coreui/contribute/gold-sponsor-40960/). A big company logo will be added here with a link to your website.
236+
237+
<a href="https://opencollective.com/coreui/contribute/gold-sponsor-40960/checkout"><img src="https://opencollective.com/coreui/tiers/gold-sponsor/0/avatar.svg?avatarHeight=100"></a>
238+
239+
### Silver Sponsors
240+
241+
Support this project by [becoming a Silver Sponsor](https://opencollective.com/coreui/contribute/silver-sponsor-40967/). A medium company logo will be added here with a link to your website.
242+
243+
<a href="https://opencollective.com/coreui/contribute/silver-sponsor-40967/checkout"><img src="https://opencollective.com/coreui/tiers/gold-sponsor/0/avatar.svg?avatarHeight=100"></a>
244+
245+
### Bronze Sponsors
246+
247+
Support this project by [becoming a Bronze Sponsor](https://opencollective.com/coreui/contribute/bronze-sponsor-40966/). The company avatar will show up here with a link to your OpenCollective Profile.
248+
249+
<a href="https://opencollective.com/coreui/contribute/bronze-sponsor-40966/checkout"><img src="https://opencollective.com/coreui/tiers/bronze-sponsor/0/avatar.svg?avatarHeight=100"></a>
250+
251+
### Backers
252+
253+
Thanks to all the backers and sponsors! Support this project by [becoming a backer](https://opencollective.com/coreui/contribute/backer-40965/).
254+
255+
<a href="https://opencollective.com/coreui/contribute/backer-40965/checkout" target="_blank" rel="noopener"><img src="https://opencollective.com/coreui/backers.svg?width=890"></a>
256+
257+
<!--- EndOpenCollectiveBackers -->
258+
259+
## Copyright and license
260+
261+
Copyright 2022 creativeLabs Łukasz Holeczek. Code released under the [MIT License](https://github.com/coreui/coreui-react/blob/main/LICENSE). Docs released under [Creative Commons](https://creativecommons.org/licenses/by/3.0/).

0 commit comments

Comments
0 (0)
Morty Proxy This is a proxified and sanitized view of the page, visit original site.