Skip to content

Commit f3409c4

Browse files
authored
Update README.md
1 parent a3a58f2 commit f3409c4

File tree

1 file changed

+72
-16
lines changed

1 file changed

+72
-16
lines changed

README.md

Lines changed: 72 additions & 16 deletions
Original file line numberDiff line numberDiff line change
@@ -1,26 +1,82 @@
1-
# vue-cli
1+
# 🚀 Sing App Vue Dashboard - free and open source admin dashboard
22

3-
## Project setup
3+
Responsive admin dashboard template built with Vue.js and Bootstrap 4. Developed with ❤️ by [Flatlogic](https://flatlogic.com/).
4+
5+
[View Demo](http://sing-app-vue.herokuapp.com) | [Download](https://github.com/flatlogic/sing-app-vue-dashboard/archive/master.zip) | [More templates](https://flatlogic.com/admin-dashboards)
6+
7+
![image](https://user-images.githubusercontent.com/24964748/48494482-05a3ba80-e83f-11e8-95e6-4a6d2e76687b.png)
8+
9+
This dashboard is a small version of our [Sing App Vue Full](https://flatlogic.com/admin-dashboards/sing-app-vue). There are all ready-to-use components, that are in full version. It is built on the top of vue-cli-3, so it well supported along the web. You can easy customize template by changing SCSS variables. All paddings and colors are in _variables.scss file.
10+
11+
## Features
12+
13+
Using this template you will be able to leverage lots of built-in components and thus focus on building features that set you apart from competitors rather than bulding everything from scratch. Lite version of a Sing-app includes following features and pages:
14+
15+
* Bootstrap 4+ & SCSS
16+
* Responsive layout
17+
* Simple login / logout
18+
* Styled Bootstrap components like buttons, modals, etc
19+
20+
21+
## Pages
22+
We have implemented some basic pages, so you can see our template in action.
23+
24+
* Dashboard sample
25+
* Typography
26+
* Tables
27+
* Notifications
28+
* Charts
29+
* Icons
30+
* Maps
31+
* Hover sidebar
32+
* Chat
33+
* Login
34+
35+
## Instalation
36+
37+
1. Clone repository
38+
```shell
39+
git clone https://github.com/flatlogic/sing-app-vue-dashboard
40+
```
41+
2. Get in the project folder
42+
```shell
43+
cd sing-app-vue-dashboard
444
```
45+
3. Install dependencies via npm or yarn
46+
```shell
47+
npm install
48+
```
49+
```shell
550
yarn install
651
```
752

8-
### Compiles and hot-reloads for development
9-
```
53+
## Quick start
54+
Run development server
55+
```shell
1056
yarn run serve
1157
```
1258

13-
### Compiles and minifies for production
14-
```
15-
yarn run build
16-
```
59+
## Support
60+
For any additional information please refer to [Flatlogic homepage](https://flatlogic.com).
1761

18-
### Run your tests
19-
```
20-
yarn run test
21-
```
62+
## How can I support developers?
63+
- Star our GitHub repo :star:
64+
- [Tweet about it](https://twitter.com/intent/tweet?text=Amazing%20dashboard%20built%20with%20Vue%20and%20Bootstrap!&url=https://github.com/flatlogic/sing-app-vue-dashboard&via=flatlogic).
65+
- Create pull requests, submit bugs, suggest new features or documentation updates :wrench:
66+
- Follow [@flatlogic on Twitter](https://twitter.com/flatlogic).
67+
- Subscribe to Flatlogic newsletter at [flatlogic.com](https://flatlogic.com/)
68+
- Like our page on [Facebook](https://www.facebook.com/flatlogic/) :thumbsup:
2269

23-
### Lints and fixes files
24-
```
25-
yarn run lint
26-
```
70+
## More from Flatlogic
71+
- [Awesome Bootstrap Checkboxes & Radios](https://github.com/flatlogic/awesome-bootstrap-checkbox) - ✅ Pure css way to make inputs look prettier
72+
- [React Native Starter](https://github.com/flatlogic/react-native-starter) - 🚀 A powerful react native starter template that bootstraps development of your mobile application
73+
- [React Dashboard](https://github.com/flatlogic/react-dashboard) - 🔥 React Dashboard - isomorphic admin dashboard template with GraphQL
74+
- [Sing App](https://github.com/flatlogic/sing-app) - 💥 Free and open-source admin dashboard template built with Bootstrap 4
75+
- [Light Blue Dashboard](https://github.com/flatlogic/light-blue-dashboard) - 💦 Free and open-source admin dashboard template built with Bootstrap
76+
77+
## Premium themes
78+
Looking for premium themes and templates? Check out our other template at [flatlogic.com](https://flatlogic.com/templates).
79+
80+
## License
81+
82+
Sing App Lite version is [MIT](https://github.com/flatlogic/sing-app/blob/master/LICENSE.txt)-licensed.

0 commit comments

Comments
 (0)