Skip to content

Commit 0bd89d5

Browse files
committed
updated pipeline , readme and added assets
1 parent f745798 commit 0bd89d5

File tree

5 files changed

+74
-104
lines changed

5 files changed

+74
-104
lines changed
Lines changed: 5 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
name: Publish Package to NPM
1+
name: Publish Package to NPM
22
on:
33
release:
44
types: [created]
@@ -15,7 +15,10 @@ jobs:
1515
with:
1616
node-version: '16.x'
1717
registry-url: 'https://registry.npmjs.org'
18-
18+
19+
- name: Install Dependicies
20+
run : npm install
21+
1922
- name: Build
2023
run: npm run build
2124

README.md

Lines changed: 23 additions & 94 deletions
Original file line numberDiff line numberDiff line change
@@ -1,12 +1,12 @@
1-
# ![img](https://lh5.googleusercontent.com/KTsxxY4oI66ejQrBgqLfzHK9eJY4lpZNm8XzyAiPR2WGFoL8hc9hENMT0QyQTzNaNpwgyKdRahFUeGw2HB6wEGMehP8kzY8OW9bLylcKCbxpI_Oev6qmidivhNU_ui8wLEM84-iHigas5nuEu0OxLjU)Overview
1+
# ![Create a sample project](./assets/roverForBright.png)Overview
22

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.
44

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.
66

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.
88

9-
To Install:
9+
#### To Install:
1010

1111
npm install @rover-tools/cli -g
1212

@@ -17,113 +17,42 @@ To Install:
1717
* Python 3
1818
* AWS SAM CLI
1919

20-
# Features of Rover
2120

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.
2321

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.
2523

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
2725

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
3127

3228
```sh
3329
$ 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
4433
```
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
5435
```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 select your 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+
6541
```
42+
**Note**: update and deploy should be done within the SAM project
6643

67-
### Add Components and Modules to Existing SAM
6844

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 select your 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
8347

84-
### Deploy SAM projects through CLI and CI/CD Pipeline
48+
###### Adds Components and Modules to Existing SAM
8549

86-
Deploying SAM projects to AWS through CLI and CI/CD Pipeline.
8750

88-
```sh
89-
$  rover deploy
90-
1)repository and pipeline
91-
2)cli
92-
```
51+
###### Generates CI/CD Pipeline in SAM projects
9352

94-
#### Deploying SAM project through CI/CD Pipeline
9553

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
106-
Environment 1:dev
107-
Please select your components:
108-
build,
109-
deploy
110-
Stack Name —> dev:rovertest
111-
Deployment Bucket —>devDeployment Region:ap-south-1
112-
Deployment Parameter —> dev
113-
```
114-
115-
#### Deploying SAM project through CLI
54+
###### Deploys SAM project through CLI
11655

117-
```sh
118-
| $ rover deploy
119-
1)repository and pipeline
120-
2)cli
121-
Deploy through:cli
122-
Stack Name —> rovertest
123-
Deployment Bucket —>devDeployment
124-
Region:ap-south-1
125-
Deployment Parameter —> dev
126-
```
12756

12857
# Keywords
12958

assets/roverForBright.png

37 KB
Loading

package-lock.json

Lines changed: 45 additions & 7 deletions
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

package.json

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -5,7 +5,7 @@
55
},
66
"dependencies": {
77
"@iarna/toml": "^2.2.5",
8-
"@rover-tools/engine": "file:../rover-engine",
8+
"@rover-tools/engine": "^0.0.47",
99
"@types/inquirer": "^8.2.1",
1010
"esm": "^3.2.25",
1111
"immer": "^9.0.14",

0 commit comments

Comments
 (0)