You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
# Overview
2
2
3
-
Rover is a backend automation package that generates SAM projects based on user requirements. And deploys SAM project both through CLI and Pipeline. It has a set of predefined modules and components like Auth, CRUD, etc which are commonly used by the system.
3
+
Rover is a npm package or CLI-based that generates or updates SAM projects based on predefined modules and components. it also helps in deployment by generating CI/CD pipeline or deploy through CLI in few clicks.
4
4
5
-
Modules are the small functional unit of the project like Email Authentication. Components combine AWS services like Lambda with S3 as Trigger.
5
+
Modules are the small functional unit of the project like Email Authentication. Components are combination of AWS services like Lambda with S3 as Trigger.
6
6
7
-
It is designed using typescript and is a CLI-based library that supports Node and Python with a limited set of AWS Services.
7
+
It is a CLI-based library that supports Node and Python with a some AWS Services.
8
8
9
-
To Install:
9
+
#### To Install:
10
10
11
11
npm install @rover-tools/cli -g
12
12
@@ -17,113 +17,42 @@ To Install:
17
17
* Python 3
18
18
* AWS SAM CLI
19
19
20
-
# Features of Rover
21
20
22
-
In Rover, we have predefined modules, we can select them and create our project or we have options to create custom modules by selecting the components in that module.
23
21
24
-
### Create New SAM Projects Based on Modules
22
+
In Rover, we have predefined modules, we can select them and create our project or we have options to create custom modules by selecting the components in that module.
25
23
26
-
Rover is a package or CLI-based library that generates SAM projects based on user input. It takes three inputs from the user:
24
+
# Usage
27
25
28
-
* App Name which is of User’s choice.
29
-
* App Language is Node and Python
30
-
* App Type is a list of predefined modules.
26
+
#### Create or Update
31
27
32
28
```sh
33
29
$ rover init
34
-
1)Create new SAM project
35
-
2)add component to existing SAM
36
-
3)add modules to existing SAMAnswer: Create a new SAM projectApp
37
-
Name: dgb
38
-
Choose your language: Node
39
-
Type:1. Email Auth Module: Authentication module using Cognito
40
-
2. Customizable:Create your own module
41
-
Answer:Email Auth Module: Authentication module using CognitoStack
42
-
Name: email
43
-
Do you want to add one or more components to module: No
30
+
1) create new SAM project
31
+
2) add components to existing SAM
32
+
3) add modules to existing SAM
44
33
```
45
-
46
-
### Create Custom Modules based on Components
47
-
48
-
In Rover, we will be defining a module configuration template which is a standard template where the template resources are defined. It will have details of the module:
49
-
50
-
* The number of stacks.
51
-
* Resources in the stack.
52
-
* Stack configuration - Policies and Environment variables in JSON.
53
-
34
+
#### Deploy
54
35
```sh
55
-
$ rover init
56
-
1)Create new SAM project
57
-
2)add component to existing SAM
58
-
3)add modules to existing SAM
59
-
App Name: dgb
60
-
Choose your language: Node
61
-
Type:Customizable: Create your own moduleStrack
62
-
Name: custom
63
-
Please selectyour component: S3_lambda
64
-
Do you want to add one or more components to module: No
36
+
$ rover deploy
37
+
1) generate pipeline
38
+
2) cli
39
+
3) repository and pipeline
40
+
65
41
```
42
+
**Note**: update and deploy should be done within the SAM project
66
43
67
-
### Add Components and Modules to Existing SAM
68
44
69
-
Modules are a small functional unit of the project like Email Authentication. Components combine AWS services like Lambda with S3 as Trigger.
70
-
71
-
```sh
72
-
$ rover init
73
-
1)Create new SAM project
74
-
2)add component to existing SAM
75
-
3)add modules to existing SAMAnswer:add component to existing SAM
76
-
App Name: dgb
77
-
Choose your language: Node
78
-
Select the module to which you want to add the component:emailEmailAuthModule
79
-
80
-
Please selectyour components: S3_lambda
81
-
Do you want to add one or more components to module: No
82
-
```
45
+
# Features of Rover
46
+
###### Creates new SAM project with predefined Modules and Components
83
47
84
-
### Deploy SAM projects through CLI and CI/CD Pipeline
48
+
###### Adds Components and Modules to Existing SAM
85
49
86
-
Deploying SAM projects to AWS through CLI and CI/CD Pipeline.
87
50
88
-
```sh
89
-
$ rover deploy
90
-
1)repository and pipeline
91
-
2)cli
92
-
```
51
+
###### Generates CI/CD Pipeline in SAM projects
93
52
94
-
#### Deploying SAM project through CI/CD Pipeline
95
53
96
-
```sh
97
-
Deploy through:repository and pipeline
98
-
Name:dgb
99
-
App Name:dgbRepo Type:public
100
-
Tools:git
101
-
Language:js
102
-
Framework:sam
103
-
Accesskey:[hidden}
104
-
Secretkey:[hidden]
105
-
Please enter the required number of Environments(dev,test) you want:1
0 commit comments