Skip to content

Commit 8723aa5

Browse files
updated readme.md
1 parent 9a8663b commit 8723aa5

File tree

1 file changed

+84
-20
lines changed

1 file changed

+84
-20
lines changed

README.md

Lines changed: 84 additions & 20 deletions
Original file line numberDiff line numberDiff line change
@@ -1,26 +1,90 @@
1-
# vue-cli
1+
# Sing App Vue Dashboard - free and open source admin dashboard template
2+
Including responsive layout and high quality UI built with Bootstrap 4.5.
23

3-
## Project setup
4-
```
5-
yarn install
6-
```
4+
[View Demo](https://flatlogic.com/templates/sing-app-vue-dashboard/demo) | [Download](https://github.com/flatlogic/sing-app-vue-dashboard/archive/master.zip) | [Available versions](https://flatlogic.github.io/sing-app-vue-dashboard/#/app/dashboard) | [More templates](https://flatlogic.com/admin-dashboards) | [Support forum](https://flatlogic.com/forum)
75

8-
### Compiles and hot-reloads for development
9-
```
10-
yarn run serve
11-
```
6+
[![header_illustration_fb](https://user-images.githubusercontent.com/36201579/40110692-554a4650-5909-11e8-8cde-30a0dd1f65ad.jpg)](https://flatlogic.github.io/sing-app-vue-dashboard/#/app/dashboard)
127

13-
### Compiles and minifies for production
14-
```
15-
yarn run build
16-
```
8+
This repository contains a limited free version of [Sing App Vue Dashboard](https://flatlogic.github.io/sing-app-vue-dashboard/#/app/dashboard). [Full bootstrap 4](https://flatlogic.com/admin-dashboards/sing-app-html5/demo), [React](https://flatlogic.com/admin-dashboards/sing-app-react/demo) with backend, [Vue.js](https://flatlogic.com/admin-dashboards/sing-app-vue/demo), [Angular](https://flatlogic.com/admin-dashboards/sing-app-angular/demo) and [Angular JS](https://flatlogic.com/admin-dashboards/sing-app-angularjs/demo) versions are also available and are shipped in a full package.
179

18-
### Run your tests
19-
```
20-
yarn run test
21-
```
10+
## Features
2211

23-
### Lints and fixes files
24-
```
25-
yarn run lint
12+
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:
13+
* Bootstrap 4+ & SCSS
14+
* Responsive layout
15+
* Styled Bootstrap components like buttons, modals, etc
16+
* Dashboard sample
17+
* Typography
18+
* Tables
19+
* Notifications
20+
* Base charts
21+
* Icons
22+
* Maps
23+
* Hover sidebar
24+
25+
All other features like themining, login, additional pages, etc are available in a [full version](https://flatlogic.com/templates/sing-app-vue).
26+
27+
[![full-version](https://user-images.githubusercontent.com/36201579/40107708-aa2939d6-5901-11e8-8fc1-b31ad46326b7.png)](https://flatlogic.com/admin-dashboards/sing-app-html5/demo)
28+
29+
Building a project from scratch means that there is a lot of things to keep track of all at once: analytics, dynamic forms data, UI and UX elements, and much more. This simple admin template is well suited for web apps or any other website or project that requires admin dashboard. This template will serve as a solid foundation for your upcoming project and will save you a lot of time and, hence, money.
30+
31+
## Quick Start
32+
33+
#### 1. Get the latest version
34+
35+
You can start by cloning the latest version of Sing App Vue Dashboard on your local machine by running:
36+
37+
```shell
38+
$ git clone -o sing-app-lite -b master --single-branch \
39+
https://github.com/flatlogic/sing-app.git MyApp
40+
$ cd MyApp
2641
```
42+
43+
#### 2. Run `yarn install`
44+
45+
This will install both run-time project dependencies and developer tools listed
46+
in [package.json](../package.json) file. We are moving all dependencies to npm, so there will be no bower dependencies soon.
47+
48+
#### 3. Run `yarn build`
49+
50+
This command will build the app from the source files (`/src`) into the output
51+
`/dist` folder. Then open `dist/index.html` in your browser.
52+
53+
Now you can open your web app in a browser, on mobile devices and start
54+
hacking. The page must be served from a web server, e.g. apache, nginx, WebStorm built-in web server, etc., otherwise some features may not work properly.
55+
56+
#### 3. Run `yarn serve`
57+
This command will watch for changes in `/src` and recompile vue templates & scss styles on the fly.
58+
59+
For more information please refer to full [documentation](https://demo.flatlogic.com/sing-app/documentation).
60+
61+
62+
## Integration
63+
[![integration sample](https://user-images.githubusercontent.com/1212194/40719370-1931c15c-641c-11e8-8285-a950eb155582.png)](https://flatlogic.com/templates/sing-app-vue/demo)
64+
65+
Sing App is a part of admin dashboard solution provided by Flatlogic. We can integrate admin dashboards with such systems as your accounting software, customer relationship management (CRM) system, email management, marketing automation, website analytics program, etc. Customized Sing App can be a great way to learn about your products usability and extendability. With this dashboard, the owner of the website (platform) can easily track orders and their success rate, track social metrics such as the most popular referring social media sites and their appropriate URLs, monitor sales states and periods of growth to better understand what makes users tick. [Contact us](https://flatlogic.com/contact) to learn more.
66+
67+
## Documentation
68+
For full documentation, visit [https://demo.flatlogic.com/sing-app/documentation/](https://demo.flatlogic.com/sing-app/documentation/).
69+
70+
## Support
71+
For any additional information please go to our [**support forum**](https://flatlogic.com/forum) and raise your questions or feedback provide there. We highly appreciate your participation!
72+
73+
## How can I support developers?
74+
- Star our GitHub repo :star:
75+
- [Tweet about it](https://twitter.com/intent/tweet?text=Amazing%20dashboard%20built%20with%20NodeJS,%20React%20and%20Bootstrap!&url=https://github.com/flatlogic/sing-app&via=flatlogic).
76+
- Create pull requests, submit bugs, suggest new features or documentation updates :wrench:
77+
- Follow [@flatlogic on Twitter](https://twitter.com/flatlogic).
78+
- Subscribe to Flatlogic newsletter at [flatlogic.com](https://flatlogic.com/)
79+
- Like our page on [Facebook](https://www.facebook.com/flatlogic/) :thumbsup:
80+
81+
## More from Flatlogic
82+
- [Awesome Bootstrap Checkboxes & Radios](https://github.com/flatlogic/awesome-bootstrap-checkbox) - ✔️Pure css way to make inputs look prettier
83+
- [React Native Starter](https://github.com/flatlogic/react-native-starter) - 🚀 A powerful react native starter template that bootstraps development of your mobile application
84+
85+
## Premium themes
86+
Looking for premium themes and templates? Check out our other templates at [flatlogic.com](https://flatlogic.com/templates).
87+
88+
## License
89+
90+
Sing App Vue Dashboard version is [MIT](https://github.com/flatlogic/sing-app-vue-dashboard/blob/master/LICENCE)-licensed.

0 commit comments

Comments
 (0)