Skip to content

Commit b1b4418

Browse files
Update README.md
1 parent 00f8c44 commit b1b4418

File tree

1 file changed

+265
-1
lines changed

1 file changed

+265
-1
lines changed

README.md

Lines changed: 265 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1 +1,265 @@
1-
# [Argon Dashboard React NodeJS](https://argon-dashboard-react-nodejs.creative-tim.com/auth/login)
1+
# [Argon Dashboard React NodeJS](https://argon-dashboard-react-nodejs.creative-tim.com/) [![Tweet](https://img.shields.io/twitter/url/http/shields.io.svg?style=social&logo=twitter)](https://twitter.com/home?status=Argon%20Dashboard%20is%20a%20Free%20Bootstrap%204,%20React%20and%20Reactstrap%20Dashboard%20made%20using%20create-react-app%20%E2%9D%A4%EF%B8%8F%0Ahttps%3A//demos.creative-tim.com/argon-dashboard-react%20%23react%20%23reactstrap%20%23createreactapp%20%23argon%20%23argondesign%20%23reactdashboard%20%23argonreact%20%23reactdesign%20%23bootstrap%20%23material%20%23design%20%23uikit%20%23freebie%20%20via%20%40CreativeTim)
2+
3+
4+
![version](https://img.shields.io/badge/version-1.2.0-blue.svg) ![license](https://img.shields.io/badge/license-MIT-blue.svg) [![GitHub issues open](https://img.shields.io/github/issues/creativetimofficial/argon-dashboard-react.svg?maxAge=2592000)](https://github.com/creativetimofficial/argon-dashboard-react/issues?q=is%3Aopen+is%3Aissue) [![GitHub issues closed](https://img.shields.io/github/issues-closed-raw/creativetimofficial/argon-dashboard-react.svg?maxAge=2592000)](https://github.com/creativetimofficial/argon-dashboard-react/issues?q=is%3Aissue+is%3Aclosed) [![Join the chat at https://gitter.im/NIT-dgp/General](https://badges.gitter.im/NIT-dgp/General.svg)](https://gitter.im/creative-tim-general/Lobby) [![Chat](https://img.shields.io/badge/chat-on%20discord-7289da.svg)](https://discord.gg/E4aHAQy)
5+
6+
7+
![Product Gif](https://raw.githubusercontent.com/creativetimofficial/public-assets/master/argon-dashboard-react/argon-dashboard-react.gif)
8+
9+
Start your development with a Dashboard for [Bootstrap 4](https://getbootstrap.com/?ref=creativetim), [React](https://reactjs.org/?ref=creativetim), [NodeJS](https://nodejs.org/en/?ref=creativetim) and [Reactstrap](https://reactstrap.github.io/?ref=creativetim), made with [create-react-app](https://facebook.github.io/create-react-app/?ref=creativetim). It is open source, free and it features many components that can help you create amazing websites.
10+
11+
**Fully Coded Components**
12+
13+
Argon Dashboard React Nodejs is built with over 100 individual components, giving you the freedom of choosing and combining. All components can take variations in color, that you can easily modify using SASS files.
14+
You will save a lot of time going from prototyping to full-functional code, because all elements are implemented. This Dashboard is coming with pre-built examples, so the development process is seamless, switching from our pages to the real website is very easy to be done.
15+
Every element has multiple states for colors, styles, hover, focus, that you can easily access and use.
16+
17+
**Rest API**
18+
19+
Get connected to the real world with a fully functional API made in NodeJS, containing multiple endpoints for managing the platform, each one of them being well documented and easily configurable.
20+
21+
**Complex Documentation**
22+
23+
Each element is well presented in a very complex documentation. You can read more about the idea behind this [dashboard here](https://demos.creative-tim.com/argon-dashboard-react/#/documentation/overview?ref=creativetim). You can check the [components here](https://demos.creative-tim.com/argon-dashboard-react/#/documentation/alerts?ref=creativetim) and the [foundation here](https://demos.creative-tim.com/argon-dashboard/#/documentation/colors?ref=creativetim).
24+
25+
**Example Pages**
26+
27+
If you want to get inspiration or just show something directly to your clients, you can jump start your development with our pre-built example pages. You will be able to quickly set up the basic structure for your web project.
28+
29+
30+
## Table of Contents
31+
32+
* [Demo](#demo)
33+
* [Quick Start](#quick-start)
34+
* [Documentation](#documentation)
35+
* [File Structure](#file-structure)
36+
* [Browser Support](#browser-support)
37+
* [Resources](#resources)
38+
* [Reporting Issues](#reporting-issues)
39+
* [Licensing](#licensing)
40+
* [Useful Links](#useful-links)
41+
42+
43+
## Demo
44+
45+
| Dashboard Page | Icons Page | Tables Page | Maps Page |
46+
| --- | --- | --- | --- |
47+
| [![Dashboard Page](https://github.com/creativetimofficial/public-assets/blob/master/argon-dashboard-react/dashboard-page.png?raw=true)](https://argon-dashboard-react-nodejs.creative-tim.com/admin/index) | [![Icons Page](https://github.com/creativetimofficial/public-assets/blob/master/argon-dashboard-react/icons-page.png?raw=true)](https://argon-dashboard-react-nodejs.creative-tim.com/admin/icons) | [![Tables Page](https://github.com/creativetimofficial/public-assets/blob/master/argon-dashboard-react/tables-page.png?raw=true)](https://argon-dashboard-react-nodejs.creative-tim.com/admin/tables) | [![Maps Page](https://github.com/creativetimofficial/public-assets/blob/master/argon-dashboard-react/maps-page.png?raw=true)](https://argon-dashboard-react-nodejs.creative-tim.com/admin/maps)
48+
49+
| Register Page | Login Page Page | Profile Page |
50+
| --- | --- | --- |
51+
| [![Login Page](https://raw.githubusercontent.com/creativetimofficial/public-assets/master/argon-dashboard-react/register-page.png)](https://argon-dashboard-react-nodejs.creative-tim.com/auth/register) | [![Login Page Page](https://github.com/creativetimofficial/public-assets/blob/master/argon-dashboard-react/login-page.png?raw=true)](https://argon-dashboard-react-nodejs.creative-tim.com/auth/login) | [![Profile Page](https://github.com/creativetimofficial/public-assets/blob/master/argon-dashboard-react/user-page.png?raw=true)](https://argon-dashboard-react-nodejs.creative-tim.com/admin/user-profile)
52+
53+
[View More](https://demos.creative-tim.com/argon-dashboard-react?ref=adr-github-readme)
54+
55+
56+
## Quick start
57+
58+
- `npm i argon-dashboard-react`
59+
- [Download from Github](https://github.com/creativetimofficial/argon-dashboard-react/archive/master.zip).
60+
- [Download from Creative Tim](https://www.creative-tim.com/product/argon-dashboard-react?ref=adr-github-readme).
61+
- Install with [Bower](https://bower.io/?ref=creativetim): ```bower install argon-dashboard-react```.
62+
- Clone the repo: `git clone https://github.com/creativetimofficial/argon-dashboard-react.git`.
63+
64+
65+
## Documentation
66+
The documentation for the Material Kit is hosted at our [website](https://demos.creative-tim.com/argon-dashboard-react/#/documentation/quick-start-nodejs).
67+
68+
69+
## File Structure
70+
Within the download you'll find the following directories and files:
71+
72+
```
73+
Argon Dashboard React Nodejs
74+
.
75+
├── CHANGELOG.md
76+
├── Documentation
77+
│   └── documentation.html
78+
├── ISSUE_TEMPLATE.md
79+
├── LICENSE
80+
├── README.md
81+
├── back-end
82+
│   ├── README.md
83+
│   ├── app.js
84+
│   ├── b78de_ab899_1576205276_51a83e5f3b2afb4a72888806732c61fe.crt
85+
│   ├── b78de_ab899_457b6766b38e3a90a3a5c80685b6dd43.key
86+
│   ├── config
87+
│   │   ├── config.js
88+
│   │   ├── crons.js
89+
│   │   ├── keys.js
90+
│   │   ├── passport.js
91+
│   │   └── safeRoutes.js
92+
│   ├── models
93+
│   │   ├── activeSession.js
94+
│   │   └── user.js
95+
│   ├── package-lock.json
96+
│   ├── package.json
97+
│   └── routes
98+
│   └── users.js
99+
└── front-end
100+
├── README.md
101+
├── gulpfile.js
102+
├── jsconfig.json
103+
├── package-lock.json
104+
├── package.json
105+
├── public
106+
│   ├── apple-icon.png
107+
│   ├── favicon.ico
108+
│   ├── index.html
109+
│   └── manifest.json
110+
└── src
111+
├── assets
112+
│   ├── css
113+
│   │   ├── argon-dashboard-react.css
114+
│   │   ├── argon-dashboard-react.css.map
115+
│   │   └── argon-dashboard-react.min.css
116+
│   ├── fonts
117+
│   │   ├── nucleo.eot
118+
│   │   ├── nucleo.ttf
119+
│   │   ├── nucleo.woff
120+
│   │   └── nucleo.woff2
121+
│   ├── img
122+
│   │   ├── brand
123+
│   │   │   ├── argon-react-white.png
124+
│   │   │   ├── argon-react.png
125+
│   │   │   ├── blue.png
126+
│   │   │   ├── favicon.png
127+
│   │   │   └── white.png
128+
│   │   ├── icons
129+
│   │   │   └── common
130+
│   │   │   ├── github.svg
131+
│   │   │   └── google.svg
132+
│   │   └── theme
133+
│   │   ├── angular.jpg
134+
│   │   ├── bootstrap.jpg
135+
│   │   ├── profile-cover.jpg
136+
│   │   ├── react.jpg
137+
│   │   ├── sketch.jpg
138+
│   │   ├── team-1-800x800.jpg
139+
│   │   ├── team-2-800x800.jpg
140+
│   │   ├── team-3-800x800.jpg
141+
│   │   ├── team-4-800x800.jpg
142+
│   │   └── vue.jpg
143+
│   ├── plugins
144+
│   │   └── nucleo
145+
│   │   ├── css
146+
│   │   │   ├── nucleo-svg.css
147+
│   │   │   └── nucleo.css
148+
│   │   └── fonts
149+
│   │   ├── nucleo-icons.eot
150+
│   │   ├── nucleo-icons.svg
151+
│   │   ├── nucleo-icons.ttf
152+
│   │   ├── nucleo-icons.woff
153+
│   │   └── nucleo-icons.woff2
154+
│   └── scss
155+
│   ├── argon-dashboard
156+
│   │   ├── bootstrap
157+
│   ├── argon-dashboard-react.scss
158+
│   └── react
159+
│   ├── _buttons.scss
160+
│   ├── _mixins.scss
161+
│   ├── _navbar-dropdown.scss
162+
│   ├── _navbar.scss
163+
│   ├── _tables.scss
164+
│   ├── bootstrap
165+
│   │   └── _spinners.scss
166+
│   ├── plugins
167+
│   │   └── _plugin-react-datetime.scss
168+
│   └── react-differences.scss
169+
├── components
170+
│   ├── Footers
171+
│   │   ├── AdminFooter.js
172+
│   │   └── AuthFooter.js
173+
│   ├── Headers
174+
│   │   ├── EditHeader.js
175+
│   │   ├── Header.js
176+
│   │   └── UserHeader.js
177+
│   ├── Navbars
178+
│   │   ├── AdminNavbar.js
179+
│   │   └── AuthNavbar.js
180+
│   ├── PrivateRoute
181+
│   │   ├── AuthRoutes.js
182+
│   │   └── PrivateRoute.js
183+
│   └── Sidebar
184+
│   └── Sidebar.js
185+
├── config.js
186+
├── index.js
187+
├── layouts
188+
│   ├── Admin.js
189+
│   └── Auth.js
190+
├── network
191+
│   └── ApiAxios.js
192+
├── routes.js
193+
├── variables
194+
│   └── charts.js
195+
└── views
196+
├── Index.js
197+
└── examples
198+
├── ConfirmEmail.js
199+
├── ConfirmPassword.js
200+
├── EditProfile.js
201+
├── Icons.js
202+
├── Login.js
203+
├── Maps.js
204+
├── Profile.js
205+
├── Register.js
206+
├── ResetPassword.js
207+
├── ResetPasswordSuccess.js
208+
├── Tables.js
209+
└── UsersTable.js
210+
```
211+
212+
213+
## Browser Support
214+
215+
At present, we officially aim to support the last two versions of the following browsers:
216+
217+
<img src="https://github.com/creativetimofficial/public-assets/blob/master/logos/chrome-logo.png?raw=true" width="64" height="64"> <img src="https://raw.githubusercontent.com/creativetimofficial/public-assets/master/logos/firefox-logo.png" width="64" height="64"> <img src="https://raw.githubusercontent.com/creativetimofficial/public-assets/master/logos/edge-logo.png" width="64" height="64"> <img src="https://raw.githubusercontent.com/creativetimofficial/public-assets/master/logos/safari-logo.png" width="64" height="64"> <img src="https://raw.githubusercontent.com/creativetimofficial/public-assets/master/logos/opera-logo.png" width="64" height="64">
218+
219+
220+
221+
## Resources
222+
- Demo: <https://argon-dashboard-react-nodejs.creative-tim.com/>
223+
- Download Page: <https://www.creative-tim.com/product/argon-dashboard-react?ref=adr-github-readme>
224+
- Documentation: <https://demos.creative-tim.com/argon-dashboard-react/#/documentation/quick-start-nodejs>
225+
- License Agreement: <https://www.creative-tim.com/license?ref=adr-github-readme>
226+
- Support: <https://www.creative-tim.com/contact-us?ref=adr-github-readme>
227+
- Issues: [Github Issues Page](https://github.com/creativetimofficial/argon-dashboard-react/issues?ref=creativetim)
228+
229+
## Reporting Issues
230+
231+
We use GitHub Issues as the official bug tracker for the Material Kit. Here are some advices for our users that want to report an issue:
232+
233+
1. Make sure that you are using the latest version of the Material Kit. Check the CHANGELOG from your dashboard on our [website](https://www.creative-tim.com/?ref=adr-github-readme).
234+
2. Providing us reproducible steps for the issue will shorten the time it takes for it to be fixed.
235+
3. Some issues may be browser specific, so specifying in what browser you encountered the issue might help.
236+
237+
## Licensing
238+
239+
- Copyright 2021 Creative Tim (https://www.creative-tim.com/?ref=adr-github-readme)
240+
- Copyright 2021 Creative Tim (https://projectdata.dev/?fbclid=IwAR3NJsoVcZFDi00KyXtjCMv5vhM3CCx9nxkqcidKUJL6ajc6mtY6OwIfXiU)
241+
- Licensed under MIT (https://github.com/creativetimofficial/argon-dashboard-react/blob/master/LICENSE.md?ref=creativetim)
242+
243+
## Useful Links
244+
245+
- [Tutorials](https://www.youtube.com/channel/UCVyTG4sCw-rOvB9oHkzZD1w?ref=creativetim)
246+
- [Affiliate Program](https://www.creative-tim.com/affiliates/new?ref=adr-github-readme) (earn money)
247+
- [Blog Creative Tim](http://blog.creative-tim.com/?ref=adr-github-readme)
248+
- [Free Products](https://www.creative-tim.com/bootstrap-themes/free?ref=adr-github-readme) from Creative Tim
249+
- [Premium Products](https://www.creative-tim.com/bootstrap-themes/premium?ref=adr-github-readme) from Creative Tim
250+
- [React Products](https://www.creative-tim.com/bootstrap-themes/react-themes?ref=adr-github-readme) from Creative Tim
251+
- [Angular Products](https://www.creative-tim.com/bootstrap-themes/angular-themes?ref=adr-github-readme) from Creative Tim
252+
- [VueJS Products](https://www.creative-tim.com/bootstrap-themes/vuejs-themes?ref=adr-github-readme) from Creative Tim
253+
- [More products](https://www.creative-tim.com/bootstrap-themes?ref=adr-github-readme) from Creative Tim
254+
- Check our Bundles [here](https://www.creative-tim.com/bundles?ref=adr-github-readme)
255+
256+
### Social Media
257+
258+
Twitter: <https://twitter.com/CreativeTim?ref=creativetim>
259+
260+
Facebook: <https://www.facebook.com/CreativeTim?ref=creativetim> & <https://www.facebook.com/projectdatadevelopement/>
261+
262+
Dribbble: <https://dribbble.com/creativetim?ref=creativetim>
263+
264+
Instagram: <https://www.instagram.com/CreativeTimOfficial?ref=creativetim>
265+

0 commit comments

Comments
 (0)