|
1 | | -# javascript-scheduler-ruby-rails-application |
| 1 | +<!-- |
| 2 | + howto.md |
| 3 | + A step-by-step guide to integrate Ruby on Rails with Syncfusion TS Scheduler |
| 4 | +--> |
| 5 | +# How to Integrate Ruby on Rails with Syncfusion Scheduler |
| 6 | +This repository contains a sample full-stack application demonstrating how to display events in syncfuison Scheduler component using Ruby on Rails. |
2 | 7 |
|
3 | 8 | ## Prerequisites |
| 9 | +- Ruby - (3.2.2) |
| 10 | +- Node JS - (>=18.13.0) |
| 11 | +- Yarn - (>=1.22.19) |
4 | 12 |
|
5 | | -Ruby - 3.2.2 |
6 | | -Node Js - 18.13.0 |
7 | | -Yarn - 1.22.19 |
8 | | - |
9 | | -## Ruby setup |
10 | | - |
11 | | -You can install the Ruby from the following link. |
12 | | -[`https://www.ruby-lang.org/en/downloads/`](https://www.ruby-lang.org/en/downloads/) |
13 | | - |
14 | | -## Install Rails |
15 | | - |
| 13 | +## Project Structure |
16 | 14 | ``` |
17 | | -gem install rails |
| 15 | +├── README.md # This guide |
| 16 | +├── postcss.config.js |
| 17 | +├── package.json |
| 18 | +├── test #Testing the functionality |
| 19 | +│ ├── events_controller_test.rb |
| 20 | +│ ├── schedule_controller_test.rb |
| 21 | +└── app |
| 22 | + ├── javascript #Main JavaScript entry point that initializes frontend behavior |
| 23 | + │ ├── application.js |
| 24 | + │ ├── controllers |
| 25 | + │ │ ├── index.js |
| 26 | + └── views |
| 27 | + ├── layouts |
| 28 | + │ ├── application.html.erb #Base HTML layout wrapping all views |
| 29 | + └── welcome |
| 30 | + └── index.html.erb # View template for the welcome page |
18 | 31 | ``` |
19 | 32 |
|
20 | | -## Add Syncfusion Scheduler component in your application |
| 33 | +## Project Setup |
| 34 | +## Installation |
| 35 | +1. ### Clone the project |
| 36 | + Clone the project from the repository by creating a fork and branch. |
| 37 | +2. ### Ruby setup |
| 38 | + You can install the Ruby from the following link. |
| 39 | + [`https://www.ruby-lang.org/en/downloads/`](https://www.ruby-lang.org/en/downloads/) |
| 40 | + Then Install gem using below commands |
| 41 | + ``` |
| 42 | + gem install rails |
| 43 | + ``` |
| 44 | +3. ### Install dependencies: |
| 45 | + ```bash |
| 46 | + npm install |
| 47 | + or |
| 48 | + yarn install |
| 49 | + ``` |
| 50 | +### Running the Application |
| 51 | +1. Navigate to javascript-scheduler-ruby-rails-application folder. |
| 52 | + ```bash |
| 53 | + cd javascript-scheduler-ruby-rails-application |
| 54 | + ``` |
| 55 | +2. Start the Scheduler Frontend |
| 56 | + ```bash |
| 57 | + rails server |
| 58 | + ``` |
| 59 | +3. Navigate to `http://localhost:3000` in your browser. (or) Ctrl + click the link in your terminal |
21 | 60 |
|
22 | | -Refer the following UG documenation for adding Syncfusion React component in your application |
23 | | -* [Getting Started of Syncfusion Javascript Scheduler component](https://ej2.syncfusion.com/javascript/documentation/schedule/getting-started) |
24 | 61 |
|
25 | | -## Run the project |
| 62 | +## Output |
| 63 | + |
26 | 64 |
|
27 | | -``` |
28 | | -yarn install |
29 | | -rails server |
30 | | -``` |
| 65 | +## Troubleshooting |
| 66 | +- **Version error**: Check and install the current version as by prerequistes. |
| 67 | +- **Port already in use**: Clear all the previous running applications in both browser and command prompt. |
| 68 | +
|
| 69 | +## Liscense |
| 70 | +**License banner**: Obtain and register a Syncfusion license key [link](https://ej2.syncfusion.com/angular/documentation/licensing/overview). |
| 71 | + |
0 commit comments