-
-
Notifications
You must be signed in to change notification settings - Fork 265
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
Showing
9 changed files
with
162 additions
and
16 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
|
@@ -4,5 +4,5 @@ | |
"packages/*" | ||
], | ||
"useWorkspaces": true, | ||
"version": "4.0.0" | ||
"version": "4.0.1" | ||
} |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,157 @@ | ||
<p align="center"> | ||
<a href="https://coreui.io/"> | ||
<img | ||
src="https://coreui.io/images/brand/coreui-signet.svg" | ||
alt="CoreUI logo" | ||
width="200" | ||
/> | ||
</a> | ||
</p> | ||
|
||
<h3 align="center">CoreUI for React.js</h3> | ||
|
||
<p align="center"> | ||
React.js Components Library built on top of Bootstrap 5 and TypeScript. | ||
<br> | ||
<a href="https://coreui.io/react/docs/getting-started/introduction"><strong>Explore CoreUI for React.js docs »</strong></a> | ||
<br> | ||
<br> | ||
<a href="https://github.com/coreui/coreui-react/issues/new?template=bug_report.md">Report bug</a> | ||
· | ||
<a href="https://github.com/coreui/coreui-react/issues/new?template=feature_request.md">Request feature</a> | ||
· | ||
<a href="https://blog.coreui.io/">Blog</a> | ||
</p> | ||
|
||
|
||
## Table of contents | ||
|
||
- [Quick start](#quick-start) | ||
- [Status](#status) | ||
- [What's included](#whats-included) | ||
- [Bugs and feature requests](#bugs-and-feature-requests) | ||
- [Documentation](#documentation) | ||
- [Contributing](#contributing) | ||
- [Community](#community) | ||
- [Versioning](#versioning) | ||
- [Creators](#creators) | ||
- [Copyright and license](#copyright-and-license) | ||
|
||
## Quick start | ||
|
||
### Instalation | ||
|
||
Several quick start options are available: | ||
|
||
- [Download the latest release](https://github.com/coreui/coreui-react/archive/v4.0.1.zip) | ||
- Clone the repo: `git clone https://github.com/coreui/coreui-react.git` | ||
- Install with [npm](https://www.npmjs.com/): `npm install @coreui/react` | ||
- Install with [yarn](https://yarnpkg.com/): `yarn add @coreui/react` | ||
|
||
Read the [Getting started page](https://coreui.io/react/docs/getting-started/introduction/) for information on the framework contents, templates and examples, and more. | ||
|
||
### Stylesheets | ||
|
||
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. | ||
|
||
#### CoreUI CSS files | ||
|
||
##### Installation | ||
|
||
```bash | ||
yarn add @coreui/coreui | ||
``` | ||
|
||
or | ||
|
||
```bash | ||
npm install @coreui/coreui --save | ||
``` | ||
|
||
##### Basic usage | ||
|
||
```js | ||
import '@coreui/coreui/dist/css/coreui.min.css' | ||
``` | ||
|
||
#### Bootstrap CSS files | ||
|
||
##### Installation | ||
|
||
```bash | ||
yarn add bootstrap | ||
``` | ||
|
||
or | ||
|
||
```bash | ||
npm install bootstrap | ||
``` | ||
|
||
##### Basic usage | ||
|
||
```js | ||
import "bootstrap/dist/css/bootstrap.min.css"; | ||
``` | ||
|
||
## Status | ||
|
||
[](https://github.com/coreui/coreui-react/actions?query=workflow%3AJS+Tests+branch%3Amain) | ||
[](https://www.npmjs.com/package/@coreui/react) | ||
[](https://david-dm.org/coreui/coreui?type=peer) | ||
[](https://david-dm.org/coreui/coreui?type=dev) | ||
[](https://coveralls.io/github/coreui/coreui-react?branch=v4) | ||
|
||
## Bugs and feature requests | ||
|
||
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). | ||
|
||
## Documentation | ||
|
||
The documentation for the CoreUI & CoreUI PRO is hosted at our website [CoreUI for React](https://coreui.io/react/docs/getting-started/introduction) | ||
|
||
### Running documentation locally | ||
|
||
1. Run `yarn install` or `npm install` to install the Node.js dependencies. | ||
2. Run `yarn bootstrap` or `npm run bootstrap` to link local packages together and install remaining package dependencies. | ||
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. | ||
4. Open `http://localhost:8000/` in your browser, and voilà. | ||
|
||
## Contributing | ||
|
||
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. | ||
|
||
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/>. | ||
|
||
## Community | ||
|
||
Stay up to date on the development of CoreUI and reach out to the community with these helpful resources. | ||
|
||
- Read and subscribe to [The Official CoreUI Blog](https://blog.coreui.io/). | ||
|
||
You can also follow [@core_ui on Twitter](https://twitter.com/core_ui). | ||
|
||
## Versioning | ||
|
||
For transparency into our release cycle and in striving to maintain backward compatibility, CoreUI is maintained under [the Semantic Versioning guidelines](http://semver.org/). | ||
|
||
See [the Releases section of our project](https://github.com/coreui/coreui-react/releases) for changelogs for each release version. | ||
|
||
## Creators | ||
|
||
**Łukasz Holeczek** | ||
|
||
- <https://twitter.com/lukaszholeczek> | ||
- <https://github.com/mrholek> | ||
|
||
**Andrzej Kopański** | ||
|
||
- <https://github.com/xidedix> | ||
|
||
**The CoreUI Team** | ||
|
||
- <https://github.com/orgs/coreui/people> | ||
|
||
## Copyright and license | ||
|
||
Copyright 2021 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/). |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters