|
1 | | -[](https://github.com/coreui/coreui) |
2 | | -[![npm package][npm-coreui-badge]][npm-coreui] |
3 | | -[![NPM downloads][npm-coreui-download]][npm-coreui] |
4 | | -[](https://github.com/coreui/react) |
5 | | -[![npm package][npm-coreui-react-badge]][npm-coreui-react] |
6 | | -[![NPM downloads][npm-coreui-react-download]][npm-coreui-react] |
7 | | - |
8 | | -[npm-coreui]: https://www.npmjs.com/package/@coreui/coreui |
9 | | -[npm-coreui-badge]: https://img.shields.io/npm/v/@coreui/coreui.png?style=flat-square |
10 | | -[npm-coreui-download]: https://img.shields.io/npm/dm/@coreui/coreui.svg?style=flat-square |
11 | | -[npm-coreui-react]: https://www.npmjs.com/package/@coreui/react |
12 | | -[npm-coreui-react-badge]: https://img.shields.io/npm/v/@coreui/react.png?style=flat-square |
13 | | -[npm-coreui-react-download]: https://img.shields.io/npm/dm/@coreui/react.svg?style=flat-square |
14 | | -[npm]: https://www.npmjs.com/package/@coreui/react |
15 | | - |
16 | | -# CoreUI Free React Admin Template |
17 | | - |
18 | | -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! |
19 | | - |
20 | | -## Table of Contents |
21 | | - |
22 | | -* [Versions](#versions) |
23 | | -* [CoreUI Pro](#coreui-pro) |
24 | | -* [Quick Start](#quick-start) |
25 | | -* [Installation](#installation) |
26 | | -* [Basic usage](#basic-usage) |
27 | | -* [What's included](#whats-included) |
28 | | -* [Documentation](#documentation) |
29 | | -* [Versioning](#versioning) |
30 | | -* [Creators](#creators) |
31 | | -* [Community](#community) |
32 | | -* [Support CoreUI Development](#support-coreui-development) |
33 | | -* [Copyright and License](#copyright-and-license) |
34 | | - |
35 | | -## Versions |
36 | | - |
37 | | -* [CoreUI Free Bootstrap Admin Template](https://github.com/coreui/coreui-free-bootstrap-admin-template) |
38 | | -* [CoreUI Free Angular Admin Template](https://github.com/coreui/coreui-free-angular-admin-template) |
39 | | -* [CoreUI Free React.js Admin Template](https://github.com/coreui/coreui-free-react-admin-template) |
40 | | -* [CoreUI Free Vue.js Admin Template](https://github.com/coreui/coreui-free-vue-admin-template) |
41 | | - |
42 | | -## CoreUI Pro |
43 | | - |
44 | | -* 💪 [CoreUI Pro Angular Admin Template](https://coreui.io/product/angular-dashboard-template/) |
45 | | -* 💪 [CoreUI Pro Bootstrap Admin Template](https://coreui.io/product/bootstrap-dashboard-template/) |
46 | | -* 💪 [CoreUI Pro React Admin Template](https://coreui.io/product/react-dashboard-template/) |
47 | | -* 💪 [CoreUI Pro Vue Admin Template](https://coreui.io/product/vue-dashboard-template/) |
| 1 | +# CoreUI Web3 React Admin Template |
| 2 | +This project is a web3 version of the CoreUI React admin template. It is a fork of the CoreUI admin template built with React. |
| 3 | + |
| 4 | +Overview |
| 5 | +We have extended the functionality of the original CoreUI template by adding web3 capabilities using the following libraries: |
| 6 | + |
| 7 | +- 🌈RainBowKit - RainbowKit is a React library that makes it easy to add wallet connection to your dapp. It's intuitive, responsive and customizable. |
| 8 | +- Axios - Axios is a simple promise based HTTP client for the browser and node.js. Axios provides a simple to use library in a small package with a very extensible interface. |
| 9 | +- Redux - For state management. |
| 10 | +- Redux Saga - For managing side effects, such as fetching blockchain data. |
| 11 | + |
| 12 | +The CoreUI template already utilizes React and Bootstrap to provide a robust admin template with a wide range of UI components. |
48 | 13 |
|
49 | 14 | ## Quick Start |
| 15 | +To get started with the project: |
50 | 16 |
|
51 | | -- [Download the latest release](https://github.com/coreui/coreui-free-react-admin-template/archive/refs/heads/main.zip) |
52 | | -- Clone the repo: `git clone https://github.com/coreui/coreui-free-react-admin-template.git` |
| 17 | +Clone the repository: git clone https://github.com/treejer/coreui-free-react-admin-template-web3 |
53 | 18 |
|
54 | 19 | ### Installation |
55 | 20 |
|
|
95 | 60 | $ yarn build |
96 | 61 | ``` |
97 | 62 |
|
98 | | -## What's included |
99 | | - |
100 | | -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: |
101 | | - |
102 | | -``` |
103 | | -coreui-free-react-admin-template |
104 | | -├── public/ # static files |
105 | | -│ └── index.html # html template |
106 | | -│ |
107 | | -├── src/ # project root |
108 | | -│ ├── assets/ # images, icons, etc. |
109 | | -│ ├── components/ # common components - header, footer, sidebar, etc. |
110 | | -│ ├── layouts/ # layout containers |
111 | | -│ ├── scss/ # scss styles |
112 | | -│ ├── views/ # application views |
113 | | -│ ├── _nav.js # sidebar navigation config |
114 | | -│ ├── App.js |
115 | | -│ ├── ... |
116 | | -│ ├── index.js |
117 | | -│ ├── routes.js # routes config |
118 | | -│ └── store.js # template state example |
119 | | -│ |
120 | | -└── package.json |
| 63 | +## Env Setup |
| 64 | +Duplicate the environment file and modify its variable values. |
| 65 | +```bash |
| 66 | +cp .env.example .env |
121 | 67 | ``` |
122 | 68 |
|
123 | 69 | ## Documentation |
124 | 70 |
|
125 | 71 | The documentation for the CoreUI Admin Template is hosted at our website [CoreUI for React](https://coreui.io/react/) |
126 | 72 |
|
127 | | -## Versioning |
128 | | - |
129 | | -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/). |
130 | | - |
131 | | -See [the Releases section of our project](https://github.com/coreui/coreui-free-react-admin-template/releases) for changelogs for each release version. |
132 | | - |
133 | | -## Creators |
134 | | - |
135 | | -**Łukasz Holeczek** |
136 | | -* <https://twitter.com/lukaszholeczek> |
137 | | -* <https://github.com/mrholek> |
138 | | -* <https://github.com/coreui> |
139 | | - |
140 | | -**CoreUI team** |
141 | | -* https://github.com/orgs/coreui/people |
142 | | - |
143 | | -## Community |
144 | | - |
145 | | -Get updates on CoreUI's development and chat with the project maintainers and community members. |
146 | | - |
147 | | -- Follow [@core_ui on Twitter](https://twitter.com/core_ui). |
148 | | -- Read and subscribe to [CoreUI Blog](https://coreui.ui/blog/). |
149 | | - |
150 | | -## Support CoreUI Development |
151 | | - |
152 | | -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/). |
153 | | - |
154 | | -<!--- StartOpenCollectiveBackers --> |
155 | 73 |
|
156 | | -### Platinum Sponsors |
| 74 | +### About |
157 | 75 |
|
158 | | -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. |
| 76 | +This project is built and maintained by the [Treejer Team](https://github.com/treejer). The source code is available on [GitHub]([https://github.com/treejer](https://github.com/treejer/coreui-free-react-admin-template-web3)). |
| 77 | +Please feel free to reach out if you have any questions or need further assistance. We are happy to help! |
159 | 78 |
|
160 | | -<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> |
161 | | - |
162 | | -### Gold Sponsors |
163 | | - |
164 | | -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. |
165 | | - |
166 | | -<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> |
167 | | - |
168 | | -### Silver Sponsors |
169 | | - |
170 | | -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. |
171 | | - |
172 | | -<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> |
173 | | - |
174 | | -### Bronze Sponsors |
175 | | - |
176 | | -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. |
177 | | - |
178 | | -<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> |
179 | | - |
180 | | -### Backers |
181 | | - |
182 | | -Thanks to all the backers and sponsors! Support this project by [becoming a backer](https://opencollective.com/coreui/contribute/backer-40965/). |
183 | | - |
184 | | -<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> |
185 | | - |
186 | | -<!--- EndOpenCollectiveBackers --> |
187 | | - |
188 | | -## Copyright and License |
189 | | - |
190 | | -copyright 2023 creativeLabs Łukasz Holeczek. |
| 79 | +## Documentation |
191 | 80 |
|
192 | | - |
193 | 81 | Code released under [the MIT license](https://github.com/coreui/coreui-free-react-admin-template/blob/master/LICENSE). |
194 | | -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. |
195 | | - |
0 commit comments