initial commit
This commit is contained in:
sanaya
parent
5c3083bfe2
commit
e63e4e3d0a
192
README.md
192
README.md
@ -1,173 +1,57 @@
|
|||||||
[](https://github.com/coreui/coreui)
|
Getting Started with Create React App
|
||||||
[![npm package][npm-coreui-badge]][npm-coreui]
|
This project was bootstrapped with Create React App.
|
||||||
[![NPM downloads][npm-coreui-download]][npm-coreui]
|
|
||||||
[](https://github.com/coreui/react)
|
|
||||||
[![npm package][npm-coreui-react-badge]][npm-coreui-react]
|
|
||||||
[![NPM downloads][npm-coreui-react-download]][npm-coreui-react]
|
|
||||||
|
|
||||||
[npm-coreui]: https://www.npmjs.com/package/@coreui/coreui
|
Available Scripts
|
||||||
[npm-coreui-badge]: https://img.shields.io/npm/v/@coreui/coreui.png?style=flat-square
|
In the project directory, you can run:
|
||||||
[npm-coreui-download]: https://img.shields.io/npm/dm/@coreui/coreui.svg?style=flat-square
|
|
||||||
[npm-coreui-react]: https://www.npmjs.com/package/@coreui/react
|
|
||||||
[npm-coreui-react-badge]: https://img.shields.io/npm/v/@coreui/react.png?style=flat-square
|
|
||||||
[npm-coreui-react-download]: https://img.shields.io/npm/dm/@coreui/react.svg?style=flat-square
|
|
||||||
[npm]: https://www.npmjs.com/package/@coreui/react
|
|
||||||
|
|
||||||
# CoreUI Free React Admin Template v4
|
npm start
|
||||||
|
Runs the app in the development mode.
|
||||||
|
Open http://localhost:3000 to view it in the browser.
|
||||||
|
|
||||||
CoreUI is meant to be the UX game changer. Pure & transparent code is devoid of redundant components, so the app is light enough to offer ultimate user experience. This means mobile devices also, where the navigation is just as easy and intuitive as on a desktop or laptop. The CoreUI Layout API lets you customize your project for almost any device – be it Mobile, Web or WebApp – CoreUI covers them all!
|
The page will reload if you make edits.
|
||||||
|
You will also see any lint errors in the console.
|
||||||
|
|
||||||
## Table of Contents
|
npm test
|
||||||
|
Launches the test runner in the interactive watch mode.
|
||||||
|
See the section about running tests for more information.
|
||||||
|
|
||||||
* [Versions](#versions)
|
npm run build
|
||||||
* [CoreUI Pro](#coreui-pro)
|
Builds the app for production to the build folder.
|
||||||
* [Quick Start](#quick-start)
|
It correctly bundles React in production mode and optimizes the build for the best performance.
|
||||||
* [Installation](#installation)
|
|
||||||
* [Basic usage](#basic-usage)
|
|
||||||
* [What's included](#whats-included)
|
|
||||||
* [Documentation](#documentation)
|
|
||||||
* [Versioning](#versioning)
|
|
||||||
* [Creators](#creators)
|
|
||||||
* [Community](#community)
|
|
||||||
* [Copyright and License](#copyright-and-license)
|
|
||||||
|
|
||||||
## Versions
|
The build is minified and the filenames include the hashes.
|
||||||
|
Your app is ready to be deployed!
|
||||||
|
|
||||||
* [CoreUI Free Bootstrap Admin Template](https://github.com/coreui/coreui-free-bootstrap-admin-template)
|
See the section about deployment for more information.
|
||||||
* [CoreUI Free Angular Admin Template](https://github.com/coreui/coreui-free-angular-admin-template)
|
|
||||||
* [CoreUI Free React.js Admin Template](https://github.com/coreui/coreui-free-react-admin-template)
|
|
||||||
* [CoreUI Free Vue.js Admin Template](https://github.com/coreui/coreui-free-vue-admin-template)
|
|
||||||
|
|
||||||
## CoreUI Pro
|
npm run eject
|
||||||
|
Note: this is a one-way operation. Once you eject, you can’t go back!
|
||||||
|
|
||||||
* 💪 [CoreUI Pro Bootstrap Admin Template](https://coreui.io/pro/)
|
If you aren’t satisfied with the build tool and configuration choices, you can eject at any time. This command will remove the single build dependency from your project.
|
||||||
* 💪 [CoreUI Pro Angular Admin Template](https://coreui.io/pro/angular)
|
|
||||||
* 💪 [CoreUI Pro React Admin Template](https://coreui.io/pro/react)
|
|
||||||
* 💪 [CoreUI Pro Vue Admin Template](https://coreui.io/pro/vue)
|
|
||||||
|
|
||||||
## Quick Start
|
Instead, it will copy all the configuration files and the transitive dependencies (webpack, Babel, ESLint, etc) right into your project so you have full control over them. All of the commands except eject will still work, but they will point to the copied scripts so you can tweak them. At this point you’re on your own.
|
||||||
|
|
||||||
- [Download the latest release](https://github.com/coreui/coreui-free-react-admin-template/archive/refs/heads/main.zip)
|
You don’t have to ever use eject. The curated feature set is suitable for small and middle deployments, and you shouldn’t feel obligated to use this feature. However we understand that this tool wouldn’t be useful if you couldn’t customize it when you are ready for it.
|
||||||
- Clone the repo: `git clone https://github.com/coreui/coreui-free-react-admin-template.git`
|
|
||||||
|
|
||||||
### Instalation
|
Learn More
|
||||||
|
You can learn more in the Create React App documentation.
|
||||||
|
|
||||||
``` bash
|
To learn React, check out the React documentation.
|
||||||
$ npm install
|
|
||||||
```
|
|
||||||
|
|
||||||
or
|
Code Splitting
|
||||||
|
This section has moved here: https://facebook.github.io/create-react-app/docs/code-splitting
|
||||||
|
|
||||||
``` bash
|
Analyzing the Bundle Size
|
||||||
$ yarn install
|
This section has moved here: https://facebook.github.io/create-react-app/docs/analyzing-the-bundle-size
|
||||||
```
|
|
||||||
|
|
||||||
### Basic usage
|
Making a Progressive Web App
|
||||||
|
This section has moved here: https://facebook.github.io/create-react-app/docs/making-a-progressive-web-app
|
||||||
|
|
||||||
``` bash
|
Advanced Configuration
|
||||||
# dev server with hot reload at http://localhost:3000
|
This section has moved here: https://facebook.github.io/create-react-app/docs/advanced-configuration
|
||||||
$ npm start
|
|
||||||
|
|
||||||
# if you use Node 17+ use this command instead of `npm start`
|
Deployment
|
||||||
$ npm run start:n17
|
This section has moved here: https://facebook.github.io/create-react-app/docs/deployment
|
||||||
```
|
|
||||||
|
|
||||||
or
|
npm run build fails to minify
|
||||||
|
This section has moved here: https://facebook.github.io/create-react-app/docs/troubleshooting#npm-run-build-fails-to-minify
|
||||||
``` bash
|
|
||||||
# dev server with hot reload at http://localhost:3000
|
|
||||||
$ yarn start
|
|
||||||
|
|
||||||
# if you use Node 17+ use this command instead of `yarn start`
|
|
||||||
$ yarn start:n17
|
|
||||||
```
|
|
||||||
|
|
||||||
Navigate to [http://localhost:3000](http://localhost:3000). The app will automatically reload if you change any of the source files.
|
|
||||||
|
|
||||||
#### Build
|
|
||||||
|
|
||||||
Run `build` to build the project. The build artifacts will be stored in the `build/` directory.
|
|
||||||
|
|
||||||
```bash
|
|
||||||
# build for production with minification
|
|
||||||
$ npm run build
|
|
||||||
|
|
||||||
# if you use Node 17+ use this command instead of `build run build`
|
|
||||||
$ npm run build:n17
|
|
||||||
```
|
|
||||||
|
|
||||||
or
|
|
||||||
|
|
||||||
```bash
|
|
||||||
# build for production with minification
|
|
||||||
$ yarn build
|
|
||||||
|
|
||||||
# if you use Node 17+ use this command instead of `yarn build`
|
|
||||||
$ yarn build:n17
|
|
||||||
```
|
|
||||||
|
|
||||||
## What's included
|
|
||||||
|
|
||||||
Within the download you'll find the following directories and files, logically grouping common assets and providing both compiled and minified variations. You'll see something like this:
|
|
||||||
|
|
||||||
```
|
|
||||||
coreui-free-react-admin-template
|
|
||||||
├── public/ # static files
|
|
||||||
│ └── index.html # html template
|
|
||||||
│
|
|
||||||
├── src/ # project root
|
|
||||||
│ ├── assets/ # images, icons, etc.
|
|
||||||
│ ├── components/ # common components - header, footer, sidebar, etc.
|
|
||||||
│ ├── layouts/ # layout containers
|
|
||||||
│ ├── scss/ # scss styles
|
|
||||||
│ ├── views/ # application views
|
|
||||||
│ ├── _nav.js # sidebar navigation config
|
|
||||||
│ ├── App.js
|
|
||||||
│ ├── ...
|
|
||||||
│ ├── index.js
|
|
||||||
│ ├── routes.js # routes config
|
|
||||||
│ └── store.js # template state example
|
|
||||||
│
|
|
||||||
└── package.json
|
|
||||||
```
|
|
||||||
|
|
||||||
## Documentation
|
|
||||||
|
|
||||||
The documentation for the CoreUI Admin Template is hosted at our website [CoreUI for React](https://coreui.io/react/)
|
|
||||||
|
|
||||||
## Versioning
|
|
||||||
|
|
||||||
For transparency into our release cycle and in striving to maintain backward compatibility, CoreUI Free Admin Template is maintained under [the Semantic Versioning guidelines](http://semver.org/).
|
|
||||||
|
|
||||||
See [the Releases section of our project](https://github.com/coreui/coreui-free-react-admin-template/releases) for changelogs for each release version.
|
|
||||||
|
|
||||||
## Creators
|
|
||||||
|
|
||||||
**Łukasz Holeczek**
|
|
||||||
* <https://twitter.com/lukaszholeczek>
|
|
||||||
* <https://github.com/mrholek>
|
|
||||||
* <https://github.com/coreui>
|
|
||||||
|
|
||||||
**CoreUI team**
|
|
||||||
* https://github.com/orgs/coreui/people
|
|
||||||
|
|
||||||
## Community
|
|
||||||
|
|
||||||
Get updates on CoreUI's development and chat with the project maintainers and community members.
|
|
||||||
|
|
||||||
- Follow [@core_ui on Twitter](https://twitter.com/core_ui).
|
|
||||||
- Read and subscribe to [CoreUI Blog](https://blog.coreui.ui/).
|
|
||||||
|
|
||||||
## Copyright and License
|
|
||||||
|
|
||||||
copyright 2021 creativeLabs Łukasz Holeczek.
|
|
||||||
|
|
||||||
|
|
||||||
Code released under [the MIT license](https://github.com/coreui/coreui-free-react-admin-template/blob/master/LICENSE).
|
|
||||||
There is only one limitation you can't can’t re-distribute the CoreUI as stock. You can’t do this if you modify the CoreUI. In past we faced some problems with persons who tried to sell CoreUI based templates.
|
|
||||||
|
|
||||||
## Support CoreUI Development
|
|
||||||
|
|
||||||
CoreUI is an MIT licensed open source project and 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 [CoreUI Pro Version](https://coreui.io/pro/).
|
|
||||||
|
|
||||||
We're also open to conversations regarding custom sponsorship / consulting arrangements. Get in touch on [Twitter](https://twitter.com/lukaszholeczek).
|
|
||||||
Loading…
Reference in New Issue
Block a user