Skip to content

Commit 7343fb5

Browse files
authored
Updated read me file
1 parent 10fd712 commit 7343fb5

File tree

1 file changed

+40
-1
lines changed

1 file changed

+40
-1
lines changed

README.md

Lines changed: 40 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,2 +1,41 @@
1-
# getting-started-with-the-vue-scheduler
1+
# Getting Started with the Vue Scheduler Component
2+
23
A quick start project that shows how to add Syncfusion's Vue Scheduler component to the Vue project. This project also includes a code snippet to populate JSON data and remote data sources and how to add appointments to the Scheduler either through local JSON data or remote service URLs, as well as how to change the default date and view.
4+
5+
Example: https://ej2.syncfusion.com/vue/demos/#/material/schedule/default.html
6+
7+
Documentation: https://ej2.syncfusion.com/vue/documentation/schedule/getting-started-vue-3/
8+
9+
10+
# Project pre-requisites
11+
12+
Make sure that you have the compatible versions of Node and Vue-Cli in your machine before starting to work on this project.
13+
14+
## How to run this application?
15+
16+
To run this application, you need to first clone the `getting-started-with-the-vue-scheduler` repository and then navigate to its appropriate path where it has been located in your system.
17+
18+
To do so, open the command prompt and run the below commands one after the other.
19+
20+
```
21+
git clone vue-example
22+
23+
cd vue-example
24+
```
25+
26+
## Installing
27+
28+
Once done with downloading, next you need to install the necessary packages required to run this application locally. The `npm install` command will install all the needed Vue packages into your current project and to do so, run the below command.
29+
30+
```
31+
npm install
32+
```
33+
34+
## Running on development server
35+
36+
Run `npm run serve` command for a dev server. Navigate to `http://localhost:8080/`. The app will automatically reload if you change any of the source files.
37+
38+
## Further help
39+
40+
To get more help on the vue CLI use go check out the [Vue-Cli README](https://github.com/vuejs/vue-cli/blob/master/README.md).
41+

0 commit comments

Comments
 (0)