Skip to content

Commit 2f81b51

Browse files
authored
Updated read me file
1 parent 02c09eb commit 2f81b51

File tree

1 file changed

+39
-1
lines changed

1 file changed

+39
-1
lines changed

README.md

Lines changed: 39 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,2 +1,40 @@
1-
# getting-started-with-the-vue-schedular
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 add appointments to the Scheduler either as local JSON data or remote service URLs, and also 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+
## Project pre-requisites
10+
11+
Make sure that you have the compatible versions of Node and Vue-Cli in your machine before starting to work on this project.
12+
13+
## How to run this application?
14+
15+
To run this application, you need to first clone the `getting-started-with-the-vue-schedular` repository and then navigate to its appropriate path where it has been located in your system.
16+
17+
To do so, open the command prompt and run the below commands one after the other.
18+
19+
```
20+
git clone vue-example
21+
22+
cd vue-example
23+
```
24+
25+
## Installing
26+
27+
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.
28+
29+
```
30+
npm install
31+
```
32+
33+
## Running on development server
34+
35+
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.
36+
37+
## Further help
38+
39+
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).
40+

0 commit comments

Comments
 (0)